forked from coop-cloud/abra
docs: short aliases, short descriptions [ci skip]
This commit is contained in:
parent
7155a33d31
commit
a3a66ef972
@ -8,6 +8,7 @@ import (
|
||||
var AppCommand = &cli.Command{
|
||||
Name: "app",
|
||||
Usage: "Manage apps",
|
||||
Aliases: []string{"a"},
|
||||
ArgsUsage: "<app>",
|
||||
Description: `
|
||||
This command provides all the functionality you need to manage the life cycle
|
||||
|
@ -39,7 +39,7 @@ var DebugFlag = &cli.BoolFlag{
|
||||
// RunApp runs CLI abra app.
|
||||
func RunApp(version, commit string) {
|
||||
app := &cli.App{
|
||||
Name: "abra",
|
||||
Name: "Abra",
|
||||
Usage: `The Co-op Cloud command-line utility belt 🎩🐇
|
||||
|
||||
____ ____ _ _
|
||||
|
@ -29,7 +29,7 @@ import (
|
||||
|
||||
var recipeListCommand = &cli.Command{
|
||||
Name: "list",
|
||||
Usage: "List all available recipes",
|
||||
Usage: "List available recipes",
|
||||
Aliases: []string{"ls"},
|
||||
Action: func(c *cli.Context) error {
|
||||
catl, err := catalogue.ReadRecipeCatalogue()
|
||||
@ -52,7 +52,8 @@ var recipeListCommand = &cli.Command{
|
||||
|
||||
var recipeVersionCommand = &cli.Command{
|
||||
Name: "versions",
|
||||
Usage: "List available versions for <recipe>",
|
||||
Usage: "List recipe versions",
|
||||
Aliases: []string{"v"},
|
||||
ArgsUsage: "<recipe>",
|
||||
Action: func(c *cli.Context) error {
|
||||
recipe := c.Args().First()
|
||||
@ -88,6 +89,7 @@ var recipeVersionCommand = &cli.Command{
|
||||
var recipeCreateCommand = &cli.Command{
|
||||
Name: "create",
|
||||
Usage: "Create a new recipe",
|
||||
Aliases: []string{"c"},
|
||||
ArgsUsage: "<recipe>",
|
||||
Action: func(c *cli.Context) error {
|
||||
recipe := c.Args().First()
|
||||
@ -154,8 +156,9 @@ var recipeCreateCommand = &cli.Command{
|
||||
}
|
||||
|
||||
var recipeUpgradeCommand = &cli.Command{
|
||||
Name: "upgrade",
|
||||
Usage: "Upgrade recipe image tags",
|
||||
Name: "upgrade",
|
||||
Usage: "Upgrade recipe image tags",
|
||||
Aliases: []string{"u"},
|
||||
Description: `
|
||||
This command reads and attempts to parse all image tags within the given
|
||||
<recipe> configuration and prompt with more recent tags to upgrade to. It will
|
||||
@ -286,8 +289,9 @@ This is step 1 of upgrading a recipe. Step 2 is running "abra recipe sync
|
||||
}
|
||||
|
||||
var recipeSyncCommand = &cli.Command{
|
||||
Name: "sync",
|
||||
Usage: "Generate recipe labels",
|
||||
Name: "sync",
|
||||
Usage: "Generate new recipe labels",
|
||||
Aliases: []string{"s"},
|
||||
Description: `
|
||||
This command will generate labels for each service which correspond to the
|
||||
following format:
|
||||
@ -355,7 +359,8 @@ the versioning metadata of up-and-running containers are.
|
||||
|
||||
var recipeLintCommand = &cli.Command{
|
||||
Name: "lint",
|
||||
Usage: "Recipe configuration linter",
|
||||
Usage: "Lint a recipe",
|
||||
Aliases: []string{"l"},
|
||||
ArgsUsage: "<recipe>",
|
||||
Action: func(c *cli.Context) error {
|
||||
recipe := c.Args().First()
|
||||
@ -447,11 +452,14 @@ var recipeLintCommand = &cli.Command{
|
||||
|
||||
// RecipeCommand defines the `abra recipe` command and ets subcommands
|
||||
var RecipeCommand = &cli.Command{
|
||||
Name: "recipe",
|
||||
Usage: "Manage recipes",
|
||||
Name: "recipe",
|
||||
Usage: "Manage recipes",
|
||||
ArgsUsage: "<recipe>",
|
||||
Aliases: []string{"r"},
|
||||
Description: `
|
||||
A recipe is a blueprint for an app. It describes how to deploy and maintain an
|
||||
app.
|
||||
A recipe is a blueprint for an app. It is a bunch of configuration files which
|
||||
describe how to deploy and maintain an app. Recipes are maintained by the Co-op
|
||||
Cloud community and you can use Abra to read them and create apps for you.
|
||||
`,
|
||||
Subcommands: []*cli.Command{
|
||||
recipeListCommand,
|
||||
|
@ -7,7 +7,8 @@ import (
|
||||
// ServerCommand defines the `abra server` command and its subcommands
|
||||
var ServerCommand = &cli.Command{
|
||||
Name: "server",
|
||||
ArgsUsage: "<host>",
|
||||
ArgsUsage: "<server>",
|
||||
Aliases: []string{"s"},
|
||||
Usage: "Manage servers",
|
||||
Description: `
|
||||
Manage the lifecycle of a server.
|
||||
|
@ -7,7 +7,7 @@ import (
|
||||
// VersionCommand prints the version of abra.
|
||||
var VersionCommand = &cli.Command{
|
||||
Name: "version",
|
||||
Usage: "Print the version",
|
||||
Usage: "Print version",
|
||||
Action: func(c *cli.Context) error {
|
||||
cli.VersionPrinter(c)
|
||||
return nil
|
||||
|
Loading…
Reference in New Issue
Block a user