Commands Reference¶
See Options Reference for a list and descriptions of command options.
| Command | Shortcut | Options | Description |
|---|---|---|---|
active-serving-watcher |
asw | -k, -i | Watches all running recipes in a kitchen |
config |
c | -c, -f, -g | Configure Command Line |
config-list |
cl | Print the current configuration | |
context-delete |
cd | -y | Delete a context |
context-list |
xl | List available contexts | |
context-switch |
cs | -y | Create or switch to a new context |
file-compile |
fc | -v, -f | Apply variables to a file |
file-delete |
fd | -k, -r, -m, -y | Delete one or more recipe files |
file-diff |
fdi | -k, -r | Show differences with remote version of a file |
file-get |
fg | Get the latest version of a file | |
file-history |
fh | -cc | Show file change history |
file-merge |
fm | To be used after kitchen-merge-preview | |
file-resolve |
fr | Mark a conflicted file as resolved | |
file-update |
fu | -k, -r, -m | Update a recipe file |
git-setup |
gs | Set up a GIT repository for DataKitchen CLI | |
kitchen-config |
kf | -k, -a, -g, -u, -la | Get and set kitchen variable overrides |
kitchen-create |
kc | -p | Create and name a new child kitchen |
kitchen-delete |
kd | -y | Provide the name of the kitchen to delete |
kitchen-get |
kg | -r, -a | Get an existing kitchen locally |
kitchen-history |
kh | -k, -c | List history of commits in a kitchen |
kitchen-list |
kl | List all kitchens | |
kitchen-merge |
km | -sk, -tk | Merge two kitchens |
kitchen-merge-preview |
kmp | -cpr, -sk, -tk | Preview the merge of two kitchens |
kitchen-revert |
kr | -k, -y | Reverts the latest commit in a kitchen Revert with caution. Kitchen revert will roll back previous updates and merges and can impact your environment. The kitchen-revert command should only be used with caution! |
kitchen-settings-get |
ksg | Get kitchen settings (kitchen-settings.json) | |
kitchen-settings-update |
ksu | Upload kitchen settings | |
kitchen-which |
kw | What kitchen am I working in? | |
order-delete |
od | -k, -o, -y | Delete one order or all orders in a kitchen |
order-list |
ol | -k, -oc, -orc, -r, -s | List orders in a kitchen. |
order-run |
or | -k, -r, -n, -p, -y, -w | Run an order, run recipe variation |
order-stop |
os | -k, -o | Stop an order - Turn off the serving generation ability of an order. Stop any running jobs. Keep all state around. |
orderrun-delete |
ord | -k, -y | Delete the order run specified by the order run ID argument |
orderrun-info |
ori | -k, -o, -ori, -s, -ns, -fl, -l, -lt, -t -q, -at --runstatus, --disp_order_id, --disp_orderrun_id | Display information about an order run |
orderrun-resume |
orr | -k | Resume a failed order run |
orderrun-stop |
ors | -k, -ori | Stop the run of an order |
recipe-compile |
rc | -k, -r, -v | Apply variables to a recipe |
recipe-create |
re | -k, -tm | Create a new recipe |
recipe-delete |
rd | -k, -y | Delete local and remote copy of the given recipe |
recipe-get |
rg | Get the latest remote versions of recipe | |
recipe-ingredient-list |
ril | Show the available ingredients for the recipe | |
recipe-list |
rl | -k | List the recipes in a kitchen |
recipe-status |
rs | Compare local recipe to remote recipe | |
recipe-update |
ru | -m, -d | Update all of the changed files for the recipe |
recipe-validate |
rv | -v | Validate local copy of a recipe |
recipe-variation-list |
rvl | -k, -r | Show the available variations for the recipe |
secret-delete |
sd | -y | Delete a secret |
secret-exists |
se | Check if a secret exists | |
secret-list |
sl | List secrets | |
secret-write |
sw | Write one secret to the vault | |
user-info |
ui | Get information about this user | |
vault-config |
vc | -k, -h, -s, -u, -t, -r, -p, -i, -y | Configure vault |
vault-delete |
vd | -k, -y | Delete kitchen vault configuration |
vault-info |
vi | -k, -g | List vault info |