Go to file
Marc Khouzam 45360a55cc
Allow sourcing zsh completion script (#1917)
Although it is not the recommended approach, sourcing a completion
script is the simplest way to get people to try using shell completion.
Not allowing it for zsh has turned out to complicate shell completion
adoption.  Further, many tools modify the zsh script to allow sourcing.

This commit allows sourcing of the zsh completion script.

Signed-off-by: Marc Khouzam <marc.khouzam@gmail.com>
2023-03-22 18:41:05 -04:00
.github update copyright year (#1927) 2023-03-05 21:28:31 -05:00
doc update copyright year (#1927) 2023-03-05 21:28:31 -05:00
.gitignore leverage makefile to run build tasks (#976) 2020-02-20 12:25:38 -07:00
.golangci.yml update copyright year (#1927) 2023-03-05 21:28:31 -05:00
.mailmap Add .mailcap for a more tidy "git shortlog" output 2015-11-20 15:24:23 -07:00
active_help_test.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
active_help.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
active_help.md Add Active Help support (#1482) 2022-06-15 20:08:16 -04:00
args_test.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
args.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
bash_completions.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
bash_completions.md Bash completion V2 with completion descriptions (#1146) 2021-06-30 15:24:58 -06:00
bash_completionsV2_test.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
bash_completionsV2.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
cobra_test.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
cobra.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
command_notwin.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
command_test.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
command_win.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
command.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
completions_test.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
completions.go Allow sourcing zsh completion script (#1917) 2023-03-22 18:41:05 -04: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
fish_completions_test.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
fish_completions.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
fish_completions.md Extend Go completions and revamp zsh comp (#1070) (#1070) 2020-06-29 13:52:14 -06:00
flag_groups_test.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
flag_groups.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
go.mod build(deps): bump github.com/inconshreveable/mousetrap (#1872) 2023-01-03 02:43:06 +00:00
go.sum build(deps): bump github.com/inconshreveable/mousetrap (#1872) 2023-01-03 02:43:06 +00: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
powershell_completions_test.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
powershell_completions.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
powershell_completions.md powershell completion with custom comp (#1208) 2020-12-29 07:57:32 -07:00
projects_using_cobra.md Update projects_using_cobra.md (#1932) 2023-03-14 08:28:50 -04:00
README.md Update badge route (#1884) 2022-12-23 15:54:16 -05:00
shell_completions.go update copyright year (#1927) 2023-03-05 21:28:31 -05:00
shell_completions.md Add keeporder to shell completion (#1903) 2023-02-25 15:57:12 -05:00
user_guide.md Document suggested layout for subcommands (#1930) 2023-03-16 21:03:29 -04:00
zsh_completions_test.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.md Improve zsh completion documentation (#1169) 2020-07-19 16:02:46 -06:00

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