You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -80,7 +80,7 @@ which maintains the same interface while adding POSIX compliance.
80
80
81
81
# Installing
82
82
Using Cobra is easy. First, use `go get` to install the latest version
83
-
of the library.
83
+
of the library.
84
84
85
85
```
86
86
go get -u github.com/spf13/cobra@latest
@@ -105,8 +105,8 @@ go install github.com/spf13/cobra-cli@latest
105
105
106
106
For complete details on using the Cobra-CLI generator, please read [The Cobra Generator README](https://github.com/spf13/cobra-cli/blob/main/README.md)
107
107
108
-
For complete details on using the Cobra library, please read the [The Cobra User Guide](user_guide.md).
108
+
For complete details on using the Cobra library, please read the [The Cobra User Guide](site/content/user_guide.md).
109
109
110
110
# License
111
111
112
-
Cobra is released under the Apache 2.0 license. See [LICENSE.txt](https://github.com/spf13/cobra/blob/master/LICENSE.txt)
112
+
Cobra is released under the Apache 2.0 license. See [LICENSE.txt](LICENSE.txt)
For backward compatibility, Cobra still supports its bash legacy dynamic completion solution.
419
-
Please refer to [Bash Completions](bash_completions.md) for details.
419
+
Please refer to [Bash Completions](bash.md) for details.
420
420
421
421
### Bash completion V2
422
422
@@ -425,13 +425,13 @@ Cobra provides two versions for bash completion. The original bash completion (
425
425
426
426
A new V2 bash completion version is also available. This version can be used by calling `GenBashCompletionV2()` or
427
427
`GenBashCompletionFileV2()`. The V2 version does **not** support the legacy dynamic completion
428
-
(see [Bash Completions](bash_completions.md)) but instead works only with the Go dynamic completion
428
+
(see [Bash Completions](bash.md)) but instead works only with the Go dynamic completion
429
429
solution described in this document.
430
430
Unless your program already uses the legacy dynamic completion solution, it is recommended that you use the bash
431
431
completion V2 solution which provides the following extra features:
432
432
- Supports completion descriptions (like the other shells)
433
433
- Small completion script of less than 300 lines (v1 generates scripts of thousands of lines; `kubectl` for example has a bash v1 completion script of over 13K lines)
434
-
- Streamlined user experience thanks to a completion behavior aligned with the other shells
434
+
- Streamlined user experience thanks to a completion behavior aligned with the other shells
435
435
436
436
`Bash` completion V2 supports descriptions for completions. When calling `GenBashCompletionV2()` or `GenBashCompletionFileV2()`
437
437
you must provide these functions with a parameter indicating if the completions should be annotated with a description; Cobra
@@ -448,7 +448,7 @@ show (show information of a chart)
448
448
$ helm s[tab][tab]
449
449
search show status
450
450
```
451
-
**Note**: Cobra's default `completion` command uses bash completion V2. If for some reason you need to use bash completion V1, you will need to implement your own `completion` command.
451
+
**Note**: Cobra's default `completion` command uses bash completion V2. If for some reason you need to use bash completion V1, you will need to implement your own `completion` command.
452
452
## Zsh completions
453
453
454
454
Cobra supports native zsh completion generated from the root `cobra.Command`.
@@ -482,7 +482,7 @@ search show status
482
482
### Zsh completions standardization
483
483
484
484
Cobra 1.1 standardized its zsh completion support to align it with its other shell completions. Although the API was kept backward-compatible, some small changes in behavior were introduced.
485
-
Please refer to [Zsh Completions](zsh_completions.md) for details.
485
+
Please refer to [Zsh Completions](zsh.md) for details.
486
486
487
487
## fish completions
488
488
@@ -535,7 +535,7 @@ search (search for a keyword in charts) show (show information of a chart) s
535
535
536
536
# With descriptions and Mode 'MenuComplete' The description of the current selected value will be displayed below the suggestions.
0 commit comments