golang/mikael/madonctl: comparison vendor/github.com/spf13/cobra/README.md

equal deleted inserted replaced

-:db4911b0c721
+:445e01aede7e
 ![cobra logo](https://cloud.githubusercontent.com/assets/173412/10886352/ad566232-814f-11e5-9cd0-aa101788c117.png)
-Cobra is both a library for creating powerful modern CLI applications as well as a program to generate applications and command files.
+Cobra is a library for creating powerful modern CLI applications.
-Cobra is used in many Go projects such as [Kubernetes](http://kubernetes.io/),
+Cobra is used in many Go projects such as [Kubernetes](https://kubernetes.io/),
 [Hugo](https://gohugo.io), and [Github CLI](https://github.com/cli/cli) to
 name a few. [This list](./projects_using_cobra.md) contains a more extensive list of projects using Cobra.
 [![](https://img.shields.io/github/workflow/status/spf13/cobra/Test?longCache=tru&label=Test&logo=github%20actions&logoColor=fff)](https://github.com/spf13/cobra/actions?query=workflow%3ATest)
-[![GoDoc](https://godoc.org/github.com/spf13/cobra?status.svg)](https://godoc.org/github.com/spf13/cobra)
+[![Go Reference](https://pkg.go.dev/badge/github.com/spf13/cobra.svg)](https://pkg.go.dev/github.com/spf13/cobra)
 [![Go Report Card](https://goreportcard.com/badge/github.com/spf13/cobra)](https://goreportcard.com/report/github.com/spf13/cobra)
 [![Slack](https://img.shields.io/badge/Slack-cobra-brightgreen)](https://gophers.slack.com/archives/CD3LP1199)
-# Table of Contents
-- [Overview](#overview)
-- [Concepts](#concepts)
-* [Commands](#commands)
-* [Flags](#flags)
-- [Installing](#installing)
-- [Usage](#usage)
-* [Using the Cobra Generator](user_guide.md#using-the-cobra-generator)
-* [Using the Cobra Library](user_guide.md#using-the-cobra-library)
-* [Working with Flags](user_guide.md#working-with-flags)
-* [Positional and Custom Arguments](user_guide.md#positional-and-custom-arguments)
-* [Example](user_guide.md#example)
-* [Help Command](user_guide.md#help-command)
-* [Usage Message](user_guide.md#usage-message)
-* [PreRun and PostRun Hooks](user_guide.md#prerun-and-postrun-hooks)
-* [Suggestions when "unknown command" happens](user_guide.md#suggestions-when-unknown-command-happens)
-* [Generating documentation for your command](user_guide.md#generating-documentation-for-your-command)
-* [Generating shell completions](user_guide.md#generating-shell-completions)
-- [Contributing](CONTRIBUTING.md)
-- [License](#license)
 # 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
+* Optional seamless integration with [viper](https://github.com/spf13/viper) for 12-factor apps
 # Concepts
 Cobra is built on a structure of commands, arguments & flags.
 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](https://godoc.org/github.com/spf13/cobra#Command)
+[More about cobra.Command](https://pkg.go.dev/github.com/spf13/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](https://golang.org/pkg/flag/).
 library](https://github.com/spf13/pflag), 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. This command will install the `cobra` generator executable
+of the library.
-along with the library and its dependencies:
-go get -u github.com/spf13/cobra
+```
+go get -u github.com/spf13/cobra@latest
+```
 Next, include Cobra in your application:
 ```go
 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.
-See [User Guide](user_guide.md).
+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](https://github.com/spf13/cobra-cli/blob/main/README.md)
+For complete details on using the Cobra library, please read the [The Cobra User Guide](user_guide.md).
 # License
 Cobra is released under the Apache 2.0 license. See [LICENSE.txt](https://github.com/spf13/cobra/blob/master/LICENSE.txt)

changeset 260	445e01aede7e
parent 256	6d9efbef00a9
child 265	05c40b36d3b2