Documentation
¶
Overview ¶
Package flags provides the command line interface for the Defacto2 server application. With the configuration of the application done using the environment variables, the use of commands should be kept to a minimum.
Index ¶
- Constants
- Variables
- func Address(_ io.Writer, c *config.Config) *cli.Command
- func App(w io.Writer, ver string, c *config.Config) *cli.App
- func Arch() string
- func Commit(ver string) string
- func Config(_ io.Writer, c *config.Config) *cli.Command
- func Copyright() string
- func Fix(_ io.Writer, c *config.Config) *cli.Command
- func OS() string
- func Vers(version string) string
- func Version(s string) string
- type ExitCode
Constants ¶
View Source
const ( Title = "Defacto2 web application" // Title of this program. Domain = "defacto2.net" // Domain of the website. Program = "defacto2-server" // Program is the command line name of this program. Author = "Ben Garrett" // Author is the primary programmer of this program. Email = "contact@defacto2.net" // Email contact for public display. RecentYear = 2025 // Most recent year of compilation for this program. )
Variables ¶
View Source
var ErrNoConfig = errors.New("cannot run command as config is nil")
Functions ¶
func App ¶
App returns the command line interface for this program. It uses the github.com/urfave.cli/v2 package.
func Commit ¶
Commit returns a formatted, git commit description for the repository, including git tag version and git commit date.
func Copyright ¶
func Copyright() string
Copyright returns a "©" copyright symbol, the respective years and author of this program.
The most recent copyright year is generated from the last commit date.
func Vers ¶
Vers returns a formatted version. The version string is generated by GoReleaser.
Types ¶
Click to show internal directories.
Click to hide internal directories.