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:
parent
b1d9b4b857
commit
3c409ca3f3
@ -10,7 +10,7 @@ import (
|
|||||||
|
|
||||||
// configGetCmd represents the config get command
|
// configGetCmd represents the config get command
|
||||||
var configGetCmd = &cobra.Command{
|
var configGetCmd = &cobra.Command{
|
||||||
Use: "get KEY",
|
Use: "get <key>",
|
||||||
Short: "Get config",
|
Short: "Get config",
|
||||||
Args: cobra.ExactArgs(1),
|
Args: cobra.ExactArgs(1),
|
||||||
Run: func(cmd *cobra.Command, args []string) {
|
Run: func(cmd *cobra.Command, args []string) {
|
||||||
|
@ -12,7 +12,7 @@ import (
|
|||||||
|
|
||||||
// configSetCmd represents the config set command
|
// configSetCmd represents the config set command
|
||||||
var configSetCmd = &cobra.Command{
|
var configSetCmd = &cobra.Command{
|
||||||
Use: "set KEY VALUE",
|
Use: "set <key> <value>",
|
||||||
Short: "Set config",
|
Short: "Set config",
|
||||||
Args: cobra.ExactArgs(2),
|
Args: cobra.ExactArgs(2),
|
||||||
Run: func(cmd *cobra.Command, args []string) {
|
Run: func(cmd *cobra.Command, args []string) {
|
||||||
|
@ -15,7 +15,7 @@ import (
|
|||||||
|
|
||||||
// endpointGroupInspectCmd represents the endpoint group inspect command
|
// endpointGroupInspectCmd represents the endpoint group inspect command
|
||||||
var endpointGroupInspectCmd = &cobra.Command{
|
var endpointGroupInspectCmd = &cobra.Command{
|
||||||
Use: "inspect",
|
Use: "inspect <name>",
|
||||||
Short: "Inspect an endpoint group",
|
Short: "Inspect an endpoint group",
|
||||||
Example: " psu endpoint group inspect production",
|
Example: " psu endpoint group inspect production",
|
||||||
Args: cobra.ExactArgs(1),
|
Args: cobra.ExactArgs(1),
|
||||||
|
@ -16,7 +16,7 @@ import (
|
|||||||
|
|
||||||
// endpointInspectCmd represents the endpoint inspect command
|
// endpointInspectCmd represents the endpoint inspect command
|
||||||
var endpointInspectCmd = &cobra.Command{
|
var endpointInspectCmd = &cobra.Command{
|
||||||
Use: "inspect",
|
Use: "inspect <name>",
|
||||||
Short: "Inspect an endpoint",
|
Short: "Inspect an endpoint",
|
||||||
Example: " psu endpoint inspect primary",
|
Example: " psu endpoint inspect primary",
|
||||||
Args: cobra.MaximumNArgs(1),
|
Args: cobra.MaximumNArgs(1),
|
||||||
|
@ -15,7 +15,7 @@ import (
|
|||||||
|
|
||||||
// stackDeployCmd represents the undeploy command
|
// stackDeployCmd represents the undeploy command
|
||||||
var stackDeployCmd = &cobra.Command{
|
var stackDeployCmd = &cobra.Command{
|
||||||
Use: "deploy STACK_NAME",
|
Use: "deploy <name>",
|
||||||
Short: "Deploy a new stack or update an existing one",
|
Short: "Deploy a new stack or update an existing one",
|
||||||
Aliases: []string{"up", "create"},
|
Aliases: []string{"up", "create"},
|
||||||
Example: " psu stack deploy mystack --stack-file mystack.yml",
|
Example: " psu stack deploy mystack --stack-file mystack.yml",
|
||||||
|
@ -18,7 +18,7 @@ import (
|
|||||||
|
|
||||||
// stackInspectCmd represents the stack inspect command
|
// stackInspectCmd represents the stack inspect command
|
||||||
var stackInspectCmd = &cobra.Command{
|
var stackInspectCmd = &cobra.Command{
|
||||||
Use: "inspect",
|
Use: "inspect <name>",
|
||||||
Short: "Inspect a stack",
|
Short: "Inspect a stack",
|
||||||
Example: " psu stack inspect mystack",
|
Example: " psu stack inspect mystack",
|
||||||
Args: cobra.ExactArgs(1),
|
Args: cobra.ExactArgs(1),
|
||||||
|
@ -12,7 +12,7 @@ import (
|
|||||||
|
|
||||||
// stackRemoveCmd represents the remove command
|
// stackRemoveCmd represents the remove command
|
||||||
var stackRemoveCmd = &cobra.Command{
|
var stackRemoveCmd = &cobra.Command{
|
||||||
Use: "remove STACK_NAME",
|
Use: "remove <name>",
|
||||||
Short: "Remove a stack",
|
Short: "Remove a stack",
|
||||||
Aliases: []string{"rm", "down"},
|
Aliases: []string{"rm", "down"},
|
||||||
Example: " psu stack rm mystack",
|
Example: " psu stack rm mystack",
|
||||||
|
Loading…
Reference in New Issue
Block a user