Skip to content

Commit

Permalink
cmd/run: specify examples for savvy run
Browse files Browse the repository at this point in the history
  • Loading branch information
joshi4 committed Apr 28, 2024
1 parent 7102b31 commit a12e00b
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions cmd/run.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,21 @@ import (

// runCmd represents the run command
var runCmd = &cobra.Command{
Use: "run [runbookID]",
Short: "Run takes a runbook ID and runs it",
Example: "savvy run rb-runbookID",
Use: "run [runbookID]",
Short: "Run takes a runbook ID and runs it",
Example: `
# Select and run from a list of runbooks you have access to
savvy run
# Run a specific runbook
savvy run rb-runbookID
`,
Long: `
Run takes a runbook ID and runs it.
Run allows users to select any runbook and run it.
Without any arguments, savvy run will display a list of runbooks you have access to and allow you to select one to run.
If you provide a runbook ID, savvy run will run that specific runbook.
Run automatically steps though the runbook for you, there's no need manually copy paste individual commands.
`,
Expand Down

0 comments on commit a12e00b

Please sign in to comment.