Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.upstackdata.com/llms.txt

Use this file to discover all available pages before exploring further.

The upstack CLI is a thin wrapper around the Upstack API. It handles authentication, profile management, and a few ergonomics like measure-title resolution that the raw API leaves to the caller. The CLI is designed to be both a human tool and a target for AI agents. See AI agent workflow for the intended Claude-in-your-terminal use case.

​
Install

npm install -g @upstackdata/upstack-cli

​
Configure

upstack init
You’ll be prompted for:
  • API Key — your Upstack key (starts with upstack_). Mint at Settings → API Keys in the dashboard.
  • Pixel ID — the pixel uuid the key is scoped to.
Credentials live in ~/.upstackrc with file mode 0600.

​
Verify

upstack whoami
Prints the active profile, pixel id, and masked API key. If you see your pixel id, you’re set — try upstack measures next.

​
Multiple profiles

For additional environments or pixels: 
upstack init --profile staging
upstack init --profile client-b
Then pass --profile <name> on any command. See Profiles for the full reference.