Skip to content

Set Up Local Workspace

Kitchens, recipes, and recipe variations can optionally exist on a local machine.

Create a local directory

DataKitchen recommends creating a local /Kitchens directory to store your Automation assets.

(DataKitchen) ~ $ mkdir Kitchens
(DataKitchen) ~ $ cd Kitchens
(DataKitchen) ~/Kitchens $

Understand the directory structure

Kitchens and recipes fall into a hierarchical directory structure:

kitchens/
└── kitchen/
    └── recipe/
        ├── node1/
        ├── node2/
        ├── nodeX/
        ├── resources/
        ├── description.json
        ├── variables.json
        └── variations.json

Check working path

If you've configured multiple user contexts and want to make use of the general configuration, Check Working Path option, add another directory level to your kitchen's working directories. Name these levels so they match the names of your configured contexts. When this naming convention is followed you'll receive a warning if you're operating in a kitchen working directory that does not match your currently selected user context.

Configured user contexts

  • Customer1_User1
  • Customer1_User2
  • Customer2

Naming conventions

Matching kitchen working directory examples:

  • ~/Customer1_User1/Kitchens/
  • ~/Customer1_User2/Kitchens/
  • ~/Customer2/Kitchens/

or

  • ~/Kitchens/Customer1_User1/
  • ~/Kitchens/Customer1_User2/
  • ~/Kitchens/Customer2/