1
0
mirror of https://gitlab.com/psuapp/psu.git synced 2024-08-30 18:12:34 +00:00

Update usage section in commands to use <> for args

This commit is contained in:
Juan Carlos Mejías Rodríguez 2019-08-17 17:20:31 -04:00
parent b1d9b4b857
commit 3c409ca3f3
7 changed files with 7 additions and 7 deletions

View File

@ -10,7 +10,7 @@ import (
// configGetCmd represents the config get command
var configGetCmd = &cobra.Command{
Use: "get KEY",
Use: "get <key>",
Short: "Get config",
Args: cobra.ExactArgs(1),
Run: func(cmd *cobra.Command, args []string) {

View File

@ -12,7 +12,7 @@ import (
// configSetCmd represents the config set command
var configSetCmd = &cobra.Command{
Use: "set KEY VALUE",
Use: "set <key> <value>",
Short: "Set config",
Args: cobra.ExactArgs(2),
Run: func(cmd *cobra.Command, args []string) {

View File

@ -15,7 +15,7 @@ import (
// endpointGroupInspectCmd represents the endpoint group inspect command
var endpointGroupInspectCmd = &cobra.Command{
Use: "inspect",
Use: "inspect <name>",
Short: "Inspect an endpoint group",
Example: " psu endpoint group inspect production",
Args: cobra.ExactArgs(1),

View File

@ -16,7 +16,7 @@ import (
// endpointInspectCmd represents the endpoint inspect command
var endpointInspectCmd = &cobra.Command{
Use: "inspect",
Use: "inspect <name>",
Short: "Inspect an endpoint",
Example: " psu endpoint inspect primary",
Args: cobra.MaximumNArgs(1),

View File

@ -15,7 +15,7 @@ import (
// stackDeployCmd represents the undeploy command
var stackDeployCmd = &cobra.Command{
Use: "deploy STACK_NAME",
Use: "deploy <name>",
Short: "Deploy a new stack or update an existing one",
Aliases: []string{"up", "create"},
Example: " psu stack deploy mystack --stack-file mystack.yml",

View File

@ -18,7 +18,7 @@ import (
// stackInspectCmd represents the stack inspect command
var stackInspectCmd = &cobra.Command{
Use: "inspect",
Use: "inspect <name>",
Short: "Inspect a stack",
Example: " psu stack inspect mystack",
Args: cobra.ExactArgs(1),

View File

@ -12,7 +12,7 @@ import (
// stackRemoveCmd represents the remove command
var stackRemoveCmd = &cobra.Command{
Use: "remove STACK_NAME",
Use: "remove <name>",
Short: "Remove a stack",
Aliases: []string{"rm", "down"},
Example: " psu stack rm mystack",