Skip to content

Options Reference

See Commands Reference for a complete list of the CLI commands and the options available for each.

Option Shortcut Argument detail
--add -a Add a new override to this kitchen. This will update an existing override variable.
--all -a Get all recipes along with the kitchen
--all_things -at Display all information
--change_count -cc Number of last changes to display
--clean_previous_run -cpr Wipe temporary files from previously unfinished Kitchen merge
--config -c Path to config file
--count -c The number of items to display
--delete_remote -d Delete remote files to match local
--description -d Kitchen description
--disp_order_id Display the id for the order
--disp_orderrun_id Display the id for the order run
--file -f File path
--force -f Force remote version of recipe
--get -g Get the value for an override variable
--global-secrets -g List global secrets
--help Show this message and exit
--inherit -h Vault configuration inherited from parent kitchen
--inheritable -i Denotes whether custom kitchen-vault connection is inheritable by child kitchens
--interval -i Watching interval integer, in seconds
--kitchen -k Kitchen name
--listall -la List all variables and their values
--log -l Display log info
--message -m Change message
--node -n Recipe graph node name
--nodestatus -ns Displaynode status info
--now -w Used with order-run command to run once
--order_count -oc Count of Orders to display
--order_id -o Order ID
--order_run_count -orc Count of order runs to display
--orderrun_id -ori Order run ID
--params -p Overrides passed as parameters
--parent -p Parent kitchen name
--prefix -r Vault prefix (optional)
--private -p Denotes that the vault connection is private
--recipe -r Recipe name
--runstatus Display status of the run (single line)
--service -s Vault service; can be custom or default
--source_kitchen -sk Source kitchen name for merge
--start -s Start offset for displaying orders
--summary -s Display run summary information
--target_kitchen -tk Target kitchen name for merge
--template -tm Recipe template
--test -q Display test results
--timing -t Display timing results
--token -t Vault token
--unset -u Delete an override variable
--url -u Vault url (with port)
--variation -v Recipe variation name
--version Show the version and exit
--yes -y Force yes