Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.stigg.io/llms.txt

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

The Stigg CLI is currently in public beta. Feedback and bug reports are welcome.
The Stigg CLI is a REST API wrapper for your terminal. Provision customers, manage subscriptions, report usage, check entitlements — any operation available through the Stigg API is available as a command.

GitHub

stiggio/stigg-cli
1

Install

Install the Stigg CLI via Homebrew or Go:
brew tap stiggio/tools
brew install stigg
Requires Go 1.22 or later for the Go install. The binary is placed in your Go bin directory (default: $HOME/go/bin). If stigg isn’t found after installation, add it to your PATH:
export PATH="$PATH:$(go env GOPATH)/bin"
2

Authenticate

In the Stigg app, go to Settings > API keys and copy a key for the environment you want to use. You can provide the key in two ways:
# Set as an environment variable (recommended)
export STIGG_API_KEY=<YOUR_API_KEY>
stigg v1:customers list

# Or pass it inline per command
stigg v1:customers list --api-key '<YOUR_API_KEY>'
For CI/CD pipelines, store the key as a secret and inject it as STIGG_API_KEY at runtime.
Never hard-code API keys in scripts or commit them to source control.
3

Start using

Query your Stigg environment directly from the terminal:
# List all customers
stigg v1:customers list

# Retrieve a specific subscription
stigg v1:subscriptions retrieve --id sub-abc123

# Check a customer's entitlement
stigg v1:entitlements check --customer-id cust-001 --feature-id feature-api-calls

​
Common commands

Read operations
CommandDescription
stigg v1:customers listList all customers in the current environment
stigg v1:customers retrieveGet details for a specific customer
stigg v1:subscriptions listList subscriptions, optionally filtered by customer
stigg v1:subscriptions retrieveGet full details for a subscription
stigg v1:entitlements checkCheck a customer’s access to a specific feature
stigg v1:plans listList all plans in the product catalog
Write operations
CommandDescription
stigg v1:customers provisionCreate or update a customer record
stigg v1:subscriptions provisionSubscribe a customer to a plan
stigg v1:subscriptions updateUpdate an existing subscription (e.g. add-on quantities)
stigg v1:subscriptions cancelCancel a subscription immediately or at period end
stigg v1:usage reportReport metered feature usage for a customer
stigg v1:events reportSubmit a raw usage event for aggregation
Run stigg --help for the full command reference, or stigg v1:<resource> --help for flags on a specific resource.

​
Example use-cases

Debug a customer issue Check what a customer is entitled to and whether their subscription is active, without opening the Stigg console: 
stigg v1:customers retrieve --id cust-001
stigg v1:subscriptions list --customer-id cust-001
stigg v1:entitlements check --customer-id cust-001 --feature-id feature-api-calls
Seed a sandbox for local development Provision a test customer and subscription in one shot: 
stigg v1:customers provision --customer-id cust-test-001 --email dev@example.com --name "Test User"
stigg v1:subscriptions provision --customer-id cust-test-001 --plan-id plan-pro
Automate in CI/CD Provision test fixtures before integration tests run, then tear them down after: 
# Setup
export STIGG_API_KEY=$STIGG_SANDBOX_KEY
stigg v1:customers provision --customer-id cust-ci-$BUILD_ID --email ci@example.com
stigg v1:subscriptions provision --customer-id cust-ci-$BUILD_ID --plan-id plan-starter

# ... run tests ...

# Teardown
stigg v1:subscriptions cancel --customer-id cust-ci-$BUILD_ID --cancellation-date IMMEDIATE
Report usage from a script Push metered usage from a batch job or cron task: 
stigg v1:usage report --customer-id cust-001 --feature-id feature-api-calls --value 150

CLI vs MCP server

Not sure which tool to use? See the side-by-side comparison.

​
Global flags

FlagDescription
--api-keyStigg API key (overrides STIGG_API_KEY)
--helpShow command usage
--debugEnable debug logging, including HTTP request/response details
--version, -vShow the CLI version
--base-urlUse a custom API backend URL
--formatOutput format: auto, explore, json, jsonl, pretty, raw, yaml
--format-errorOutput format for errors: auto, explore, json, jsonl, pretty, raw, yaml
--transformTransform output using GJSON syntax
--transform-errorTransform error output using GJSON syntax