forest branch
Create, list, or delete layout branches. Branches work similarly to Git branches, but for your Forest UI layout, they let you isolate UI changes while you develop a feature, then push or deploy those changes when ready.
Usage
Arguments
| Argument | Description |
|---|
BRANCH_NAME | Name of the branch to create (optional, omit to list branches) |
Options
| Option | Description |
|---|
-d, --delete | Delete a branch |
--force | Skip confirmation when deleting a branch |
-o, --origin | Set the origin environment for the new branch |
-p, --projectId | The ID of the project to work on |
--format | Output format: table (default) or json |
--help | Display usage information |
Listing branches
Run forest branch without arguments to list all your existing branches:
The IS CURRENT column shows your active branch, the one your Development Environment is currently using.
Creating a branch
Append a branch name to create a new branch:
Your project must have at least one remote or production environment before you can create branches.
Branch origins
Every branch needs an origin, the environment whose layout state the branch starts from. Your layout changes build on top of the origin’s layout.
- If you omit
--origin, the CLI prompts you to select one interactively.
- Branches usually originate from your Production or a Remote Environment.
There are no specific constraints on branch names, but kebab-case is the convention. Branch names must be unique within a project.
Deleting a branch
Use the -d flag with a branch name to delete it:
You will be prompted to confirm deletion. To skip the confirmation:
Examples
