hub / github.com/urfave/cli
github.com/urfave/cli @v3.10.1 sqlite
1,123 symbols
4,319 edges
67 files
270 documented · 24%
README
Welcome to urfave/cli
urfave/cli is a declarative, simple, fast, and fun package for building command line tools in Go featuring:
- commands and subcommands with alias and prefix match support
- flexible and permissive help system
- dynamic shell completion for
bash,zsh,fish, andpowershell - no dependencies except Go standard library
- input flags for simple types, slices of simple types, time, duration, and others
- compound short flag support (
-a-b-ccan be shortened to-abc) - documentation generation in
manand Markdown (supported via theurfave/cli-docsmodule) - input lookup from:
- environment variables
- plain text files
- structured file formats (supported via the
urfave/cli-altsrcmodule)
Documentation
See the hosted documentation website at https://cli.urfave.org. Contents of
this website are built from the ./docs directory.
Support
Check the Q&A discussions. If you don't find answer to your question, create a new discussion.
If you found a bug or have a feature request, create a new issue.
Please keep in mind that this project is run by unpaid volunteers.
License
See LICENSE.
Extension points exported contracts — how you extend this code
ValueSource (Interface)ValueSource is a source which can be used to look up a value, typically for use with a cli.Flag [6 implementers]
value_source.go
ValueCreator (Interface)
ValueCreator is responsible for creating a flag.Value emulation as well as custom formatting T specifies the type C s [4 …
flag_impl.go
Flag (Interface)
Flag is a common interface related to parsing flags in cli. For more advanced flag parsing techniques, it is recommended [3 …
flag.go
ErrorFormatter (Interface)
ErrorFormatter is the interface that will suitably format the error output [2 implementers]
errors.go
CommandCategory (Interface)
CommandCategory is a category containing commands. [1 implementers]
category.go
HelpPrinterFunc (FuncType)
HelpPrinterFunc prints help for the Command.
help.go
ShellCompleteFunc (FuncType)
ShellCompleteFunc is an action to execute when the shell completion flag is set
funcs.go
Argument (Interface)
Argument captures a positional argument that can be parsed
args.go
Core symbols most depended-on inside this repo
Runcalled by 498
command_run.go
tracef
called by 174
cli.go
Error
called by 115
errors.go
EnvVars
called by 113
value_source.go
String
called by 95
flag_impl.go
Value
called by 70
command.go
Names
called by 62
flag.go
Root
called by 39
command.go
Shape
Languages
Go100%
Modules by API surface
flag_test.go177 symbols
command_test.go168 symbols
help_test.go59 symbols
args.go57 symbols
flag.go44 symbols
command.go43 symbols
value_source.go39 symbols
flag_impl.go37 symbols
help.go31 symbols
category.go30 symbols
flag_bool_with_inverse.go26 symbols
errors.go23 symbols
Used by 59 indexed graphs manifest dependencies, hub-wide
… +49 more
Dependencies from manifests, versioned
github.com/BurntSushi/tomlv1.5.0 · 1×
github.com/davecgh/go-spewv1.1.1 · 1×
github.com/pmezard/go-difflibv1.0.0 · 1×
github.com/stretchr/testifyv1.11.1 · 1×
github.com/urfave/cli-altsrc/v3v3.0.1 · 1×
github.com/urfave/cli/v3v3.1.1 · 1×
gopkg.in/yaml.v3v3.0.1 · 1×