// DOCUMENTATION

CLI in CI

Run generation and revision checks non-interactively with environment credentials.

Environment variables

REST_TEST_API_TOKEN supplies the workspace API key. REST_TEST_API_URL overrides the backend origin. Interactive login is not required in CI.

Store the key as an encrypted repository or environment secret.

- name: Generate REST Test client
  run: npx @rest-test/cli generate
  env:
    REST_TEST_API_TOKEN: ${{ secrets.REST_TEST_API_TOKEN }}

Run rest-test check after installing dependencies. Exit code 5 means definition revision or hash differs from the committed lock file.

// GET STARTED

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