npm 中文文档
cobra logo

Cobra is a library for creating powerful modern CLI applications.

Cobra is used in many Go projects such as Kubernetes, Hugo, and GitHub CLI to name a few. This list contains a more extensive list of projects using Cobra.

Overview


Cobra is a library providing a simple interface to create powerful modern CLI interfaces similar to git & go tools.

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
Intelligent suggestions (app srver... did you mean app server ?)
Automatic help generation for commands and flags
Grouping help for subcommands
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 seamless integration with viper for 12-factor apps

Concepts


Cobra is built on a structure of commands, arguments & flags.

Commandsrepresent actions, Argsare things and Flagsare modifiers for those actions.

The best applications read like sentences when used, and as a result, users intuitively know how to interact with them.

The pattern to follow is APPNAME VERB NOUN --ADJECTIVE or APPNAME COMMAND ARG --FLAG.

A few good real world examples may better illustrate this point.

In the following example, 'server' is a command, and 'port' is a flag:

  1. ``` sh
  2. hugo server --port=1313

  4. ```

In this command we are telling Git to clone the url bare.

  1. ``` sh
  2. git clone URL --bare

  4. ```

Commands


Command is the central point of the application. Each interaction that the application supports will be contained in a Command. A command can have children commands and optionally run an action.

In the example above, 'server' is the command.

More about cobra.Command

Flags


A flag is a way to modify the behavior of a command. Cobra supports fully POSIX-compliant flags as well as the Go flag package. A Cobra command can define flags that persist through to children commands and flags that are only available to that command.

In the example above, 'port' is the flag.

Flag functionality is provided by the pflaglibrary, a fork of the flag standard library which maintains the same interface while adding POSIX compliance.

Installing


Using Cobra is easy. First, use go get to install the latest version of the library.

  1. ``` sh
  2. go get -u github.com/spf13/cobra@latest

  4. ```

Next, include Cobra in your application:

  1. ``` go
  2. import "github.com/spf13/cobra"
  3. ```

Usage


cobra-cli is a command line program to generate cobra applications and command files. It will bootstrap your application scaffolding to rapidly develop a Cobra-based application. It is the easiest way to incorporate Cobra into your application.

It can be installed by running:

  1. ``` sh
  2. go install github.com/spf13/cobra-cli@latest

  4. ```

For complete details on using the Cobra-CLI generator, please read The Cobra Generator README

For complete details on using the Cobra library, please read the The Cobra User Guide.

License


Cobra is released under the Apache 2.0 license. See LICENSE.txt