Skip to main content

forest layout:apply

Apply a forest-layout.json file, produced by forest layout:pull, to an environment and team. The CLI compares the file with the target’s current layout, shows the changes, and sends them as JSON Patch operations once you confirm.

Usage

Arguments

Options

How it works

  1. The CLI reads the file and fetches the current layout of the target environment and team, for the sections present in the file.
  2. It computes the difference and prints the plan.
  3. If the target already matches the file, it stops with Nothing to apply.
  4. Once you confirm, it sends one atomic patch per section, then uploads the workflow definitions that changed.
Applying the same file twice makes no change the second time.
The target is always the --env and --team you pass, or the ones you pick at the prompt. The environment recorded in the file header is never used as a default.

Workflows across environments

Workflow definitions (BPMN) are stored per environment. A file pulled from another environment references definitions that do not exist on the target, and the CLI warns about it. Pull and apply with --with-workflows to carry the definitions along:

Examples