Skip to main content

forest layout:pull

Pull the layout of an environment, for one team, into a forest-layout.json file. The file captures the collection display settings, the sidebar folders and the workflows. Version it in Git, review it, and apply it to another environment with forest layout:apply.

Usage

Options

The layout file

The file starts with a forest header recording where it was pulled from (project, environment, team, date), followed by one section per layout domain: The header is informational: forest layout:apply never targets the environment the file came from by default.

Workflow definitions

A workflow’s behavior lives in a BPMN file stored per environment, and the layout file only references it. To move workflows to another environment, pull with --with-workflows: the CLI writes one workflows/<id>.bpmn file per workflow and removes the files of workflows that no longer exist. Then apply with --with-workflows on the target.

Examples