SOAT CLI
@soat/cli exposes every SOAT REST API operation as a sub-command generated from the OpenAPI specs.
Installation
npm install -g @soat/cli
# or
pnpm add -g @soat/cli
Authentication
soat configure
| Prompt | Description |
|---|---|
| Base URL | URL of your SOAT server (e.g. http://localhost:5047) |
| Token | JWT session token (from login-user) or sk_-prefixed API key (from create-api-key) |
soat configure --profile prod
Profiles are stored in ~/.soat/config.json.
Global Options
| Option | Description |
|---|---|
-p, --profile <name> | Use a named profile from ~/.soat/config.json |
-V, --version | Print the CLI version |
-h, --help | Display help for any command |
Environment Variables
Take precedence over stored profiles.
| Variable | Description |
|---|---|
SOAT_BASE_URL | Server base URL. When set together with SOAT_TOKEN, skips profile lookup entirely. When set alone, overrides the base URL of the resolved profile. |
SOAT_TOKEN | Bearer token — JWT session token or sk_-prefixed API key. Must be set together with SOAT_BASE_URL to skip profile lookup entirely. |
SOAT_PROFILE | Name of the profile to use when no --profile flag is passed. |
Available Commands
| Command | Description |
|---|---|
configure | Add or update a profile in ~/.soat/config.json |
list-commands | Print all available API commands |
| any operation | Call the corresponding REST API operation |
Complete list: Commands Reference.