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

tractorbeam connect

Connect a Connector to its provider.

Connect a Connector to its provider. In a terminal, open the provider’s sign-in in a browser on this machine and wait until it is connected; pass --api-key to enter an API key instead. Without a terminal, read the provider’s API key from standard input. To sign in from another machine, connect the Connector in the Console.

tractorbeam connect [flags] <connector>
Argument Description
<connector> The Connector’s name on the Branch.
Flag Description
--branch <string> Branch identifier or resource name where the Connector is defined. Defaults to the Workspace’s default Branch. Environment variable: TRACTORBEAM_BRANCH.
--api-key Connect with an API key: typed at a hidden prompt in a terminal, and otherwise read from standard input.
--oauth Connect through the provider’s sign-in in a browser, even when standard input is not a terminal.
--no-browser Print the authorization URL without opening a browser, to open in a browser on this machine.
--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.

Examples:

# Connect the github Connector through the provider's sign-in
tractorbeam connect github

# Connect the openai Connector with an API key
tractorbeam connect openai --api-key