Skip to content

// DOCUMENTATION

CLI configuration

Configure generators, output directories, config discovery, and revision locking.

rest-test.yaml

The CLI searches upward for rest-test.yaml or accepts --config. The file contains no token. Output paths must be relative to the project.

api:
  revision: latest
generation:
  types:
    enabled: true
    language: typescript
    output: src/api/types
  sdk:
    enabled: true
    target: typescript
    variant: fetch
    output: src/api/client
options:
  cleanOutput: false

Revision lock

.rest-test/lock.json contains workspace ID, revision, hash, generation time, and generator settings. It has no secret and may be committed for team reproducibility.

Safe file writing

The CLI rejects absolute, drive-prefixed, empty, and traversal paths. cleanOutput removes only a validated configured child directory; unrelated files are not deleted by default.

// GET STARTED

Bring your API workflow into one workspace.

Start with an OpenAPI or Swagger JSON definition and keep the workflow together.

Start for free