mirror of
https://github.com/spf13/cobra
synced 2025-04-28 09:37:17 +00:00
28 lines
1.1 KiB
Markdown
28 lines
1.1 KiB
Markdown
|
---
|
||
|
|
weight: 1
|
||
|
|
---
|
||
|
|
|
||
|
|
# Overview
|
||
|
|
|
||
|
|
Cobra is a library providing a simple interface to create powerful modern CLI
|
||
|
|
interfaces similar to git & go tools.
|
||
|
|
|
||
|
|
Cobra is also an application that will generate your application scaffolding to rapidly
|
||
|
|
develop a Cobra-based application.
|
||
|
|
|
||
|
|
Cobra provides:
|
||
|
|
|
||
|
|
* Easy subcommand-based CLIs: `app server`, `app fetch`, etc.
|
||
|
|
* Fully POSIX-compliant flags (including short & long versions)
|
||
|
|
* Nested subcommands
|
||
|
|
* Global, local and cascading flags
|
||
|
|
* Easy generation of applications & commands with `cobra init appname` & `cobra add cmdname`
|
||
|
|
* Intelligent suggestions (`app srver`... did you mean `app server`?)
|
||
|
|
* Automatic help generation for commands and flags
|
||
|
|
* Automatic help flag recognition of `-h`, `--help`, etc.
|
||
|
|
* Automatically generated shell autocomplete for your application (bash, zsh, fish, powershell)
|
||
|
|
* Automatically generated man pages for your application
|
||
|
|
* Command aliases so you can change things without breaking them
|
||
|
|
* The flexibility to define your own help, usage, etc.
|
||
|
|
* Optional tight integration with [viper](http://github.com/spf13/viper) for 12-factor apps
|