stainless-api-cli

Stainless CLI

[!CAUTION]

The CLI is unstable and the API may change. Please feel free to use it locally, but don't build scripts against it.

The official CLI for the Stainless REST API.

It is generated with Stainless.

Installation

Installing with Homebrew

brew tap stainless-api/tap
brew install stl

Installing with Go

go install 'github.com/stainless-api/stainless-api-cli/cmd/stl@latest'

Running Locally

./scripts/run args...

Usage

The CLI follows a resource-based command structure:

stl [resource] [command] [flags]

stl builds create \
  --project stainless \
  --revision main \
  --allow-empty \
  --branch branch \
  --commit-message commit_message \
  --target-commit-messages '{cli: cli, csharp: csharp, go: go, java: java, kotlin: kotlin, node: node, openapi: openapi, php: php, python: python, ruby: ruby, sql: sql, terraform: terraform, typescript: typescript}' \
  --target node

For details about specific commands, use the --help flag.

Global Flags

• --help - Show command line usage

• --debug - Enable debug logging (includes HTTP request/response details)

• --version, -v - Show the CLI version

• --base-url - Use a custom API backend URL

• --format - Change the output format (auto, explore, json, jsonl, pretty, raw, yaml)

• --format-error - Change the output format for errors (auto, explore, json, jsonl, pretty, raw, yaml)

• --transform - Transform the data output using GJSON syntax

• --transform-error - Transform the error output using GJSON syntax

Workspace Configuration

The CLI supports workspace configuration to avoid repeatedly specifying the project name. When you run a command, the CLI will:

1. Check if a project name is provided via command-line flag
2. If not, look for a .stainless/workspace.json file in the current directory or any parent directory
3. Use the project name from the workspace configuration if found

Initializing a Workspace

You can initialize a workspace configuration with:

stl workspace init --project your-project-name

If you don't provide the --project flag, you'll be prompted to enter a project name.

Additionally, when you run a command with a project name flag in an interactive terminal, the CLI will offer to initialize a workspace configuration for you.