Runbook CLI¶
runbook¶
runbook [OPTIONS] COMMAND [ARGS]...
Options
- --cwd <cwd>¶
Directory for operations (normally at root above runbooks, ie ../.runbook.yaml) and can be set with RUNBOOK_WORKING_DIR or WORKING_DIR environment variables
Environment variables
- ['RUNBOOK_WORKING_DIR', 'WORKING_DIR']
Provide a default for
--cwd
check¶
Check language validity and formatting of a notebook.
runbook check [OPTIONS] FILENAME
Options
- -c, --command <command>¶
Run a notebook through this custom command, ie ‘deno check {}’ where the {} is the temporary filename.
Arguments
- FILENAME¶
Required argument
convert¶
Convert an existing runbook to different format
runbook convert [OPTIONS] FILENAME OUTPUT
Arguments
- FILENAME¶
Required argument
- OUTPUT¶
Required argument
create¶
Create a new runbook from [template]
runbook create [OPTIONS] FILENAME
Options
- -t, --template <template>¶
- -l, --language <language>¶
Arguments
- FILENAME¶
Required argument
Environment variables
- TEMPLATE
Provide a default for
-t
- LANGUAGE
Provide a default for
-l
diff¶
Diff two notebooks
runbook diff [OPTIONS] NOTEBOOK_1 NOTEBOOK_2
Arguments
- NOTEBOOK_1¶
Required argument
- NOTEBOOK_2¶
Required argument
edit¶
Edit an existing runbook
runbook edit [OPTIONS] FILENAME
Arguments
- FILENAME¶
Required argument
init¶
Initialize a folder as a runbook repository
runbook init [OPTIONS]
Options
- -d, --directory <directory>¶
- -s, --skip-confirmation <skip_confirmation>¶
Environment variables
- DIRECTORY
Provide a default for
-d
- SKIP_CONFIRMATION
Provide a default for
-s
list¶
list runbooks
runbook list [OPTIONS]
plan¶
Prepares the runbook for execution by injecting parameters. Doesn’t run runbook.
runbook plan [OPTIONS] INPUT
Options
- -e, --embed <embed>¶
- -p, --params <params>¶
- -i, --identifier <identifier>¶
- -p, --prompter <prompter>¶
Arguments
- INPUT¶
Required argument
review¶
[Unimplemented] Entrypoint for reviewing runbook
runbook review [OPTIONS]
run¶
Run a notebook
runbook run [OPTIONS] FILENAME
Options
- --output <output>¶
- --interactive, --no-interactive¶
Run the notebook in interactive mode or EXPERIMENTAL non-interactive mode
Arguments
- FILENAME¶
Required argument
show¶
Show runbook parameters and metadata
runbook show [OPTIONS] RUNBOOK
Arguments
- RUNBOOK¶
Required argument
version¶
Display version information about runbook
runbook version [OPTIONS]