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

tractorbeam dev

Develop a Project on your personal Branch.

Apply a Project to your personal Branch and apply each save to it, while running the Vite development server of its App, if it has one.

tractorbeam dev [flags] [<vite-arguments>...]
Argument Description
<vite-arguments> Arguments passed to the Vite development server. Optional.
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 to fork a new personal Branch from. Default: 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.
--app <string> Name of the App whose dev server to run. Defaults to the App whose Vite configuration is in the current directory, else the Project’s one App.

Examples:

# Develop the Project on your personal Branch
tractorbeam dev

# Run the console App's dev server
tractorbeam dev --app console