Skip to content

delimit-ai/delimit-quickstart

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

delimit-quickstart

API governance in 2 minutes. Fork, push, see breaking changes blocked.

Fastest way to try

No fork needed — run the self-contained demo:

npx delimit-cli demo

Creates a sample API, introduces breaking changes, runs governance, shows gate status. Done in seconds.

What's in this repo

  • openapi.yaml — a Pet Store API with 4 endpoints
  • openapi-changed.yaml — the same spec with 5 breaking changes:
    • GET /pets/{petId} removed
    • DELETE /pets/{petId} removed
    • Pet.id type changed from string to integer
    • Pet.tag field removed
    • Pet.status enum value pending removed
  • .github/workflows/delimit.yml — runs governance on every push/PR
  • .github/workflows/drift-monitor.yml — weekly drift detection

Try the GitHub Action

  1. Fork this repo
  2. Open a PR (or push any commit)
  3. Delimit posts a governance cockpit comment:

Governance Gates

Gate Status Chain
API Lint Fail lint -> semver -> gov_evaluate
Policy Compliance Fail (5 violations) policy -> evidence_collect
Security Audit Pass security_audit -> evidence_collect
Deploy Readiness Blocked deploy_plan -> security_audit

5 breaking changes detected — deploy blocked until resolved.

  1. In enforce mode, CI fails until the breaking changes are fixed

Set up governance in your project

npx delimit-cli init         # Guided wizard: detect framework, choose policy, first lint
npx delimit-cli setup        # Configure Claude Code, Codex, Cursor, Gemini CLI

Includes compliance templates (SOC2, PCI-DSS, HIPAA) and automatic evidence collection.

GitHub Action

Simplest setup — auto-detects your spec:

- uses: delimit-ai/delimit-action@v1
  with:
    spec: api/openapi.yaml

Or compare two files explicitly:

- uses: delimit-ai/delimit-action@v1
  with:
    old_spec: openapi.yaml
    new_spec: openapi-changed.yaml
    mode: enforce

No config. No API keys. No account.


Delimit | Dashboard | GitHub Action | CLI | Docs

About

Fork, push, and see Delimit catch breaking API changes in CI. Try it in 2 minutes.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors