DataKitchen DataOps Documention

Commands & Options

Parent Command

~ $ dk
Usage: dk [OPTIONS] COMMAND [ARGS]...

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  active-serving-watcher (asw)   Watches all cooking recipes in a kitchen
  agent-status (as)              Provides information about the agent status
  config (c)                     Configure Command Line
  config-list (cl)               Print the current configuration
  context-delete (cd)            Deletes a context
  context-list (xl)              List available contexts
  context-switch (cs)            Create or switch to a new context

  file-compile (fc)              Apply variables to a file
  file-delete (fd)               Delete one or more recipe files
  file-diff (fdi)                Show differences with remote version of a file
  file-get (fg)                  Get the latest version of a file
  file-history (fh)              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)               Update a recipe file
  git-setup (gs)                 Set up a GIT repository for DK CLI

  kitchen-config (kf)            Get and set kitchen variable overrides
  kitchen-create (kc)            Create and name a new child kitchen
  kitchen-delete (kd)            Provide the name of the kitchen to delete
  kitchen-get (kg)               Get an existing kitchen locally
  kitchen-history (kh)           List history of commits in a kitchen
  kitchen-list (kl)              List all kitchens
  kitchen-merge (km)             Merge two kitchens
  kitchen-merge-preview (kmp)    Preview the merge of two kitchens
  kitchen-revert (kr)            Reverts the latest commit in a kitchen
  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)              Delete one order or all orders in a kitchen
  order-list (ol)                List orders in a kitchen.
  order-run (or)                 Run an order: cook a recipe variation
  order-stop (os)                Stop an order - Turn off the serving...
  orderrun-delete (ord)          Delete the order run specified by the...
  orderrun-info (ori)            Display information about an order run
  orderrun-resume (orr)          Resumes a failed order run
  orderrun-stop (ors)            Stop the run of an order

  recipe-compile (rc)            Apply variables to a recipe
  recipe-create (re)             Create a new recipe.
  recipe-delete (rd)             Deletes local and remote copy of the given recipe
  recipe-get (rg)                Get the latest remote versions of recipe
  recipe-ingredient-list (ril)   Shows the available ingredients for the recipe
  recipe-list (rl)               List the recipes in a kitchen
  recipe-status (rs)             Compare local recipe to remote recipe
  recipe-update (ru)             Update all of the changed files for the recipe
  recipe-validate (rv)           Validates local copy of a recipe
  recipe-variation-list (rvl)    Shows the available variations for the recipe

  secret-delete (sd)             Delete a secret
  secret-exists (se)             Checks 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)              Configure vault
  vault-delete (vd)              Delete kitchen vault configuration
  vault-info (vi)                List vault info

Use Kitchen Revert with Caution!

Note that the Kitchen Revert command line feature to rollback previous updates and merges can be dangerous! The kitchen-revert command should be used only with extreme caution!

Help

View details regarding any specific command by appending the --help option:

~ $ dk kitchen-merge --help
Usage: dk kitchen-merge [OPTIONS]

  Merge two kitchens. Provide the names of the source and target kitchens.

Options:
  -sk, --source_kitchen TEXT  source (from) kitchen name
  -tk, --target_kitchen TEXT  target (to) kitchen name  [required]
  -y, --yes                   Force yes  
  --help                      Show this message and exit.

Contextual vs. Explicit Options

DKCloudCommand can interpret arguments provided either by the context of the user's current working directory or by their explicit provision as part of a command input. Some commands accept arguments only from the context of the current working directory, some only as explicitly provided, and others accept arguments from either source. Use the --help option to view the options available for any given command. DKCloudCommand's documentation will provide contextual and explicit examples where appropriate.

See the example below for demonstrative purposes. Each of the following commands are equivalent.

~/Kitchens/Dev_Sprint/Recipe1 $ dk order-run Variation1 --yes
~/Kitchens/Dev_Sprint/Recipe1 $ dk or Variation1 -y
~/Kitchens $ dk or -k Dev_Sprint -r Recipe1 Variation1 -y

Commands

Command
Shortcut
Options

c

-c, -f, -g

fc

-v, -f

fd

-k, -r, -m, -y

fdi

-k, -r

fh

-cc

fu

-k, -r, -m

kf

-k, a, -g, -u, -la

kg

-r, -a

kh

-k, -c

km

-sk, -tk

kmp

-cpr, -sk, -tk

kr

-k, -y

od

-k, -o, -y

ol

-k, -oc, -orc, -r, -s

or

-k, -r, -n, -p, -y

os

-k, -o

orc

-ori, -sk, -tk, -y

ord

-k, -y

ori

-k, -o, -ori, -s, -ns, -l, -t, -q, --runstatus, --disp_chronos_id, --disp_mesos_id, -at

ors

-k, -ori

rc

-k, -r, -v

re

-k, -tm

rd

-k, -y

rl

-k

ru

-m, -d

vc

-k, -h, -s, -u, -t, -r, -p, -i, -y

vd

-k, -y

vi

-k, -g

Options

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_chronos_id

Display the chronos id for the Order.

--disp_orderrun_id

Display the mesos id for the OrderRun.

--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

Display node status info.

--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 whether 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.

Updated about a month ago


Commands & Options


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.