Skip to content
TeamGrid Developer

Install and authenticate

Requirements

Section titled “Requirements”
  • Node.js 22.13 through 24
  • A TeamGrid API v1 credential created in Settings → Developer
  • macOS Keychain or Linux Secret Service for persistent profiles

Install

Section titled “Install”

The Developer Platform packages are currently prereleases. Install from next and pin the resolved version in controlled environments.

Terminal window
npm install --global @teamgrid/cli@next
teamgrid --help

Create the default profile

Section titled “Create the default profile”
Terminal window
teamgrid auth login
teamgrid auth status --check

The credential prompt is masked. The secret is written to the operating-system credential store; the CLI profile file contains only non-secret location metadata.

To avoid shell history and process arguments in a non-interactive setup, pass the credential over standard input:

Terminal window
printf '%s' "$TEAMGRID_API_TOKEN" | teamgrid auth login --token-stdin

Named profiles

Section titled “Named profiles”
Terminal window
teamgrid --profile production auth login
teamgrid --profile production auth status --check
teamgrid --profile production projects list
teamgrid auth profiles

Remove a stored profile and its credential with:

Terminal window
teamgrid --profile production auth logout

Ephemeral credentials

Section titled “Ephemeral credentials”

For a short-lived CI process, provide TEAMGRID_API_TOKEN directly to the process instead of creating a persistent profile. Secret masking and log redaction still belong in the CI system.

Terminal window
TEAMGRID_API_TOKEN="$TEAMGRID_API_TOKEN" teamgrid workspace --output json

Never commit credentials, place them in command-line arguments, or print them for debugging.