tractorbeam auth
Inspect sign-in and create API keys.
Inspect how this machine signs in to Tractorbeam, and create API keys.
tractorbeam auth <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 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. |
auth token
Print an access token for Tractorbeam’s API.
tractorbeam auth token [flags]
auth create-key
Create an API key acting as you, with only the permissions you name, and print it once.
tractorbeam auth create-key [flags]
| Flag | Description |
|---|---|
--name <string> |
The API key’s purpose, such as ‘deploy from CI’. Required. |
--permission <permission> |
A permission the API key grants, such as tables:write; repeat it for each. You must hold each one yourself. See Permissions. Repeatable. Required. |
Examples:
# Create a key that reads Tables and invokes Queries
tractorbeam auth create-key --name "nightly report" --permission tables:read --permission queries:invoke