stainless-api-cli

Stainless CLI

The official CLI for the Stainless REST API.

It is generated with Stainless.

Installation

Installing with Homebrew

brew tap stainless-api/stl
brew install stl

Installing with Go

go install 'github.com/stainless-api/stainless-api-cli'

Usage

The CLI follows a resource-based command structure:

stl [resource] [command] [flags]

stl builds create [--allow-empty] [--project <name>]

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

Global Flags

• --debug - Enable debug logging (includes HTTP request/response details)
• --version, -v - Show the CLI version

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.