Skip to content
Esc
↑↓navigate↵open⌘Jpreview
On this page

tractorbeam plan

Show what applying a Project would change.

Build a Project and show what applying it would change, without changing the Branch.

tractorbeam plan [flags]
Flag Description
--config <string> The Project’s tractorbeam.config.ts. Defaults to the one in the current directory or its nearest ancestor.
--workspace <string> Workspace identifier or resource name. Environment variable: TRACTORBEAM_WORKSPACE.
--origin <string> The Tractorbeam origin to call instead of the default, such as a proxy’s. Environment variable: TRACTORBEAM_ORIGIN.
--token <string> Access token. Defaults to the saved interactive session. Environment variable: TRACTORBEAM_TOKEN.
--branch <string> Branch identifier or resource name. Defaults to the Branch you last switched to, or main. Environment variable: TRACTORBEAM_BRANCH.
--adopt Adopt each Resource the Project registers that another Project owns, keeping its data. Without it, Apply refuses such a Resource.

Examples:

# Show what applying the Project to the current Branch would change
tractorbeam plan

# Show what applying it to feature-x would change
tractorbeam plan --branch feature-x