flags

package

v1.14.0 Latest Latest Go to latest Published: Oct 5, 2026 License: GPL-3.0 Imports: 17 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Defacto2/server

Links

Open Source Insights

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 Check(_ io.Writer, c *config.Config) *cli.Command
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 TempDir(_ io.Writer, c *config.Config) *cli.Command
func Version(s string) string
func VersionCommit(ver string) string
func VersionRelease(version string) string
type ExitCode
- func Run(w io.Writer, ver string, c *config.Config) (ExitCode, error)

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 = 2026                       // Most recent year of compilation for this program.

)

Variables ¶

View Source

var ErrNoConfig = errors.New("cannot run command as config is nil")

Functions ¶

func Address ¶

func Address(_ io.Writer, c *config.Config) *cli.Command

Address command lists the server addresses.

func App ¶

func App(w io.Writer, ver string, c *config.Config) *cli.App

App returns the command line interface for this program. It uses the github.com/urfave.cli/v2 package.

func Arch ¶

func Arch() string

Arch returns the program CPU architecture.

func Check ¶ added in v1.14.0

func Check(_ io.Writer, c *config.Config) *cli.Command

Check command checks the server configuration.

func Config ¶

func Config(_ io.Writer, c *config.Config) *cli.Command

Config command lists the server configuration.

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 Fix ¶

func Fix(_ io.Writer, c *config.Config) *cli.Command

Fix command fixes the database and assets.

func OS ¶

func OS() string

OS returns the host operating system.

func TempDir ¶ added in v1.14.0

func TempDir(_ io.Writer, c *config.Config) *cli.Command

TempDir command removes all tempoary directories created by this app.

func Version ¶

func Version(s string) string

Version returns a formatted version string for this program including the VersionCommit, OS and CPU Arch.

func VersionCommit ¶ added in v1.14.0

func VersionCommit(ver string) string

VersionCommit returns a formatted, git commit description for the repository, including git tag version and git commit date.

func VersionRelease ¶ added in v1.14.0

func VersionRelease(version string) string

VersionRelease returns a formatted release version. The version string is generated by GoReleaser.

Types ¶

type ExitCode ¶

type ExitCode int // ExitCode is the exit code for this program.

const (
	Continue   ExitCode = iota - 1 // Continue is a special case to indicate the program should not exit.
	ExitOK                         // ExitOK is the exit code for a successful run.
	GenericErr                     // GenericError represents a generic error.
	UsageErr                       // UsageError is used for incorrect arguments or usage.
)

func Run ¶

func Run(w io.Writer, ver string, c *config.Config) (ExitCode, error)

Run parses optional command line arguments for this program.

Source Files ¶

View all Source files

flags.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL