// DOCUMENTATION

REST Test CLI

Initialize a local project, generate files, and compare local revision state with the workspace API.

Getting started

Install @rest-test/cli, sign in with your REST Test user account, then initialize the project. CI can use the workspace SDK-generation key instead. REST_TEST_API_URL overrides the centralized production API URL for local development.

npm install --global @rest-test/cli
rest-test login
rest-test init
rest-test generate
rest-test status

Commands

Commands return reliable exit codes and support --json where practical.

login and logout manage the local credential fallback
api export --output openapi.json downloads the saved design as OpenAPI JSON; API keys require definition:read
generate, generate types, and generate sdk write remote output
status compares lock metadata without changing files
check exits 5 when local generation is outdated
workspaces list is unavailable with workspace-scoped authentication

Getting started

Commands

Bring your API workflow into one workspace.