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

tractorbeam app

The Tractorbeam API's app operations.

tractorbeam app <subcommand> [flags]

Shared flags

Every subcommand takes these 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 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.

app list

Returns the Apps the Branch’s HEAD, or a retained Commit on it, selects, each with the URL serving it on the Branch and, for a web App, its sign-in client. Needs Workspace authority; an App token can’t list Apps.

tractorbeam app list [flags]
Flag Description
--at-commit-id <string> The ID of a retained Commit on the Branch to read at. Defaults to the Branch’s HEAD.
--branch <string> Branch name. Defaults to the Branch you last switched to, or main. Environment variable: TRACTORBEAM_BRANCH.

app get

Returns the App with this name selected by the Branch’s HEAD or by a retained Commit on it, along with the URL serving it on the Branch and, for a web App, its sign-in client. Returns 404 when none is selected. Needs Workspace authority; an App token can’t retrieve Apps.

tractorbeam app get [flags] <app>
Argument Description
<app> The name of the App to retrieve.
Flag Description
--at-commit-id <string> The ID of a retained Commit on the Branch to read at. Defaults to the Branch’s HEAD.
--branch <string> Branch name. Defaults to the Branch you last switched to, or main. Environment variable: TRACTORBEAM_BRANCH.