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