// 💾 SUPPLIER BACKUP
Go to file
Radek Smid bcfcff729e
Add Taikun CloudWorks to list of projects (#2098)
2024-01-15 08:38:50 -05:00
.github build(deps): bump actions/labeler from 4 to 5 (#2086) 2023-12-23 14:52:45 -05:00
assets Update main image to better handle dark background (#1883) 2023-03-22 18:41:51 -04:00
doc Fix linter errors (#2052) 2023-10-27 06:23:45 -04:00
site/content Add Taikun CloudWorks to list of projects (#2098) 2024-01-15 08:38:50 -05:00
.gitignore leverage makefile to run build tasks (#976) 2020-02-20 12:25:38 -07:00
.golangci.yml golangci: enable 'unused' and disable deprecated replaced by it (#1983) 2023-07-18 09:51:36 -04:00
.mailmap Add .mailcap for a more tidy "git shortlog" output 2015-11-20 15:24:23 -07:00
CONDUCT.md Cobra User Contract (#1292) 2021-01-26 10:55:24 -07:00
CONTRIBUTING.md Add CONTRIBUTING.md (#1183) 2020-08-10 22:14:21 -06:00
LICENSE.txt adding license 2013-09-03 18:46:13 -04:00
MAINTAINERS Add MAINTAINERS file (alphabetical order) (#1545) 2022-02-28 08:24:45 -07:00
Makefile Makefile: add target richtest (#1865) 2022-11-25 15:55:09 -05:00
README.md Move documentation sources to site/content (#1428) 2023-06-20 17:15:36 -04:00
active_help.go Add env variable to suppress completion descriptions on create (#1938) 2023-12-17 13:50:59 -05:00
active_help_test.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
args.go Micro-optimizations (#1957) 2023-11-23 12:24:33 -05:00
args_test.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
bash_completions.go Micro-optimizations (#1957) 2023-11-23 12:24:33 -05:00
bash_completionsV2.go Fix grammar: 'allows to' (#1978) 2023-06-13 11:12:49 -04:00
bash_completionsV2_test.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
bash_completions_test.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
cobra.go Micro-optimizations (#1957) 2023-11-23 12:24:33 -05:00
cobra_test.go Add tests for funcs in cobra.go (#2094) 2023-12-30 08:40:15 -05:00
command.go flags: clarify documentation that LocalFlags related function do not modify the state (#2064) 2024-01-06 16:49:13 -05:00
command_notwin.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
command_test.go Fix help text for runnable plugin command 2023-12-17 19:58:57 -05:00
command_win.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
completions.go Add env variable to suppress completion descriptions on create (#1938) 2023-12-17 13:50:59 -05:00
completions_test.go Add env variable to suppress completion descriptions on create (#1938) 2023-12-17 13:50:59 -05:00
fish_completions.go Fix typo in fish completions (#1945) 2023-04-08 00:47:33 -04:00
fish_completions_test.go test: make fish_completions_test more robust (#1980) 2023-06-16 10:25:30 -04:00
flag_groups.go Micro-optimizations (#1957) 2023-11-23 12:24:33 -05:00
flag_groups_test.go Add 'one required flag' group (#1952) 2023-07-16 12:38:22 -04:00
go.mod build(deps): bump github.com/cpuguy83/go-md2man/v2 from 2.0.2 to 2.0.3 (#2047) 2023-10-16 10:50:33 +00:00
go.sum build(deps): bump github.com/cpuguy83/go-md2man/v2 from 2.0.2 to 2.0.3 (#2047) 2023-10-16 10:50:33 +00:00
powershell_completions.go powershell: escape variable with curly brackets (#1960) 2023-06-19 12:16:18 -04:00
powershell_completions_test.go powershell: escape variable with curly brackets (#1960) 2023-06-19 12:16:18 -04:00
shell_completions.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
zsh_completions.go Allow sourcing zsh completion script (#1917) 2023-03-22 18:41:05 -04:00
zsh_completions_test.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00

README.md

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.

Go Reference Go Report Card Slack

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.

Commands represent actions, Args are things and Flags are 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:

hugo server --port=1313

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

git clone URL --bare

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 pflag library, 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.

go get -u github.com/spf13/cobra@latest

Next, include Cobra in your application:

import "github.com/spf13/cobra"

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:

go install github.com/spf13/cobra-cli@latest

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