DocsQuickstart
Quickstart
Get API governance running in 60 seconds. No account required.
1
Install the CLI
npx delimit-cli setup
This creates a .delimit/ directory with default policies and detects your OpenAPI specs automatically.
Delimit initialized.
Found: api/openapi.yaml
Policy: default (balanced)
Created: .delimit/policies.yml
2
Lint your spec for breaking changes
npx delimit-cli lint api/openapi.yaml
Compares the current spec against its last known version. Reports breaking changes with severity and migration guidance.
BREAKING: removed field `user.email` from GET /users response
WARNING: added required param `api_key` to POST /auth
OK: 14 endpoints checked, 2 issues found
3
Diff two spec versions
npx delimit-cli diff old.yaml new.yaml
Pure structural diff. Lists every addition, removal, and modification across endpoints, schemas, and parameters.
Semver: MAJOR
Changes: 3 breaking, 7 non-breaking
+ POST /v2/webhooks (added)
- DELETE /users/{id} (removed)
~ GET /orders response schema changed