CLI
The tractorbeam command builds and operates Tractorbeam Projects.
tractorbeam <subcommand> [flags]
Commands
| Command | Description |
|---|---|
init |
Create a Tractorbeam Project. |
login |
Sign in to Tractorbeam. |
logout |
Sign out of Tractorbeam on this machine. |
whoami |
Show who this machine signs in to Tractorbeam as. |
auth |
Inspect sign-in and create API keys. |
auth token |
Print an access token for Tractorbeam’s API. |
auth create-key |
Create an API key acting as you. |
configure |
Save the Workspace a Project targets. |
build |
Build a Project and its Apps. |
plan |
Show what applying a Project would change. |
apply |
Build and apply a Project to the control plane. |
deploy |
Build an App and deploy it to a Branch. |
branch |
Manage a Workspace’s Branches. |
branch list |
List the Workspace’s Branches. |
branch create |
Fork a Branch. |
branch switch |
Make a Branch current. |
branch merge |
Merge a Branch into another. |
branch delete |
Delete a Branch. |
secret |
Manage encrypted Secret values. |
secret set |
Set a Secret’s value. |
secret delete |
Delete a Secret’s value on every Branch. |
connect |
Connect a Connector to its provider. |
disconnect |
Disconnect a Connector. |
connector |
Inspect Connectors. |
connector status |
Show whether a Connector is connected. |
blobs |
Upload the files Blob fields reference. |
blobs upload |
Upload a file as a Blob. |
export |
Export the Workspace. |
import |
Import an export into the Workspace. |
dev |
Develop a Project on your personal Branch. |
mcp |
Connect agents to the Project’s MCP Servers. |
mcp add |
Add the Project’s MCP Servers to agent harnesses. |
Global flags
Every command takes these flags.
| Flag | Description |
|---|---|
--help, -h |
Show help information. |
--version, -v |
Show version information. |
--wizard |
Start wizard mode for a command. |
--completions <bash|zsh|fish|powershell|sh|pwsh> |
Print shell completion script. |
--log-level <all|trace|debug|info|warn|warning|error|fatal|none> |
Sets the minimum log level. |
--cwd <directory> |
Run as if started in this directory. |
Environment variables
A flag left out falls back to its environment variable.
| Variable | Flags |
|---|---|
TRACTORBEAM_BRANCH |
--branch |
TRACTORBEAM_ORIGIN |
--origin |
TRACTORBEAM_TOKEN |
--token |
TRACTORBEAM_WORKSPACE |
--workspace |