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

tractorbeam deploy

Build an App and deploy it to a Branch.

Build an App’s Bundle and deploy it to a Branch, where its Project is applied. Run it in the Project’s directory and name the App with --app when the Project has several.

tractorbeam deploy [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.
--app <string> Name of the App to deploy. Defaults to the Project’s one App, built by a Vite configuration under its directory.

Examples:

# Deploy the console App to the current Branch
tractorbeam deploy --app console

# Deploy it to staging
tractorbeam deploy --app console --branch staging