11# delimit-quickstart
22
3- Fork this repo, push a breaking API change, and see Delimit catch it in CI .
3+ API governance in 2 minutes. Fork, push, see breaking changes blocked .
44
5- ## What's in the box
5+ ## Fastest way to try
6+
7+ No fork needed — run the self-contained demo:
8+
9+ ``` bash
10+ npx delimit-cli demo
11+ ```
12+
13+ Creates a sample API, introduces breaking changes, runs governance, shows gate status. Done in seconds.
14+
15+ ## What's in this repo
616
717- ` openapi.yaml ` — a Pet Store API with 4 endpoints
818- ` openapi-changed.yaml ` — the same spec with 5 breaking changes:
@@ -11,37 +21,48 @@ Fork this repo, push a breaking API change, and see Delimit catch it in CI.
1121 - ` Pet.id ` type changed from ` string ` to ` integer `
1222 - ` Pet.tag ` field removed
1323 - ` Pet.status ` enum value ` pending ` removed
14- - ` .github/workflows/delimit.yml ` — runs the Delimit action on every push/PR
24+ - ` .github/workflows/delimit.yml ` — runs governance on every push/PR
25+ - ` .github/workflows/drift-monitor.yml ` — weekly drift detection
1526
16- ## Try it
27+ ## Try the GitHub Action
1728
18291 . Fork this repo
19- 2 . Push any commit (or trigger Actions manually )
20- 3 . On a PR, Delimit posts a comment like this :
30+ 2 . Open a PR (or push any commit )
31+ 3 . Delimit posts a governance cockpit comment :
2132
22- > ** Breaking API Changes Detected **
33+ > ### Governance Gates
2334>
24- > | Severity | Change | Location |
25- > | ----------| --------| ----------|
26- > | Critical | Endpoint removed | ` /pets/{petId} ` |
27- > | Warning | Type changed (string → integer) | ` Pet.id ` |
28- > | Warning | Enum value removed | ` Pet.status ` |
35+ > | Gate | Status | Chain |
36+ > | ------| --------| -------|
37+ > | API Lint | Fail | lint -> semver -> gov_evaluate |
38+ > | Policy Compliance | Fail (5 violations) | policy -> evidence_collect |
39+ > | Security Audit | Pass | security_audit -> evidence_collect |
40+ > | Deploy Readiness | Blocked | deploy_plan -> security_audit |
2941>
30- > ** Semver: MAJOR** — 5 breaking changes, migration guide included
42+ > ** 5 breaking changes detected** — deploy blocked until resolved.
43+
44+ 4 . In enforce mode, CI fails until the breaking changes are fixed
3145
32- 4 . In enforce mode, CI fails until the breaking changes are resolved
46+ ## Set up governance in your project
3347
34- ## Use Delimit in your own repo
48+ ``` bash
49+ npx delimit-cli init # Guided wizard: detect framework, choose policy, first lint
50+ npx delimit-cli setup # Configure Claude Code, Codex, Cursor, Gemini CLI
51+ ```
3552
36- The simplest setup — auto-detects the base branch and diffs your spec:
53+ Includes compliance templates (SOC2, PCI-DSS, HIPAA) and automatic evidence collection.
54+
55+ ## GitHub Action
56+
57+ Simplest setup — auto-detects your spec:
3758
3859``` yaml
3960- uses : delimit-ai/delimit-action@v1
4061 with :
4162 spec : api/openapi.yaml
4263` ` `
4364
44- Or compare two specific files:
65+ Or compare two files explicitly :
4566
4667` ` ` yaml
4768- uses : delimit-ai/delimit-action@v1
@@ -51,14 +72,8 @@ Or compare two specific files:
5172 mode : enforce
5273` ` `
5374
54- CLI:
55-
56- ` ` `
57- npx delimit-cli lint openapi.yaml
58- ```
59-
6075No config. No API keys. No account.
6176
6277---
6378
64- [ Delimit] ( https://delimit.ai ) | [ GitHub Action] ( https://github.com/marketplace/actions/delimit-api-governance ) | [ CLI] ( https://www.npmjs.com/package/delimit-cli ) | [ Live Demo ] ( https://github.com/ delimit- ai/delimit-action-demo/pull/2 )
79+ [Delimit](https://delimit.ai) | [Dashboard](https://app.delimit.ai) | [ GitHub Action](https://github.com/marketplace/actions/delimit-api-governance) | [CLI](https://www.npmjs.com/package/delimit-cli) | [Docs ](https://delimit. ai/docs )
0 commit comments