Skip to main content

Enforce Architecture Decision Records as executable rules — for both humans and AI agents

Project description

Archgate

Enterprise-grade linting and guardrails for AI work.

License: Apache-2.0 Release Docs OpenSSF Best Practices


AI agents write code fast, but they don't know your rules. Archgate turns your team's decisions into executable checks: a lint step for architecture, conventions, and AI output. Your agents read the rules before writing code, and archgate check blocks what slips through. In CI, in pre-commit hooks, and inside every major AI coding tool.

Write an ADR once. Enforce it everywhere.

How it works

Archgate has two layers:

  1. ADRs as documents: markdown files with YAML frontmatter stored in .archgate/adrs/. Each ADR records a decision: what was decided, why, and what to do and not do.
  2. ADRs as rules: each ADR can have a companion .rules.ts file that exports automated checks. Archgate runs these checks against your codebase and reports violations.
.archgate/
└── adrs/
    ├── ARCH-001-command-structure.md          # human-readable decision
    ├── ARCH-001-command-structure.rules.ts    # machine-executable checks
    ├── ARCH-002-error-handling.md
    └── ARCH-002-error-handling.rules.ts

When a rule is violated, archgate check reports the file, line, and which ADR was broken. Exit code 1 means violations. Wire it into CI and it blocks merges automatically.

The CLI is free and open source. Writing ADRs, enforcing rules, running checks in CI, and wiring up pre-commit hooks all work without an account or subscription.

Installation

Install via standalone script, npm, pip, dotnet, Go, gem, Maven, or proto. See the installation guide for all options and platform support.

Quick start

# 1. Initialize governance in your project
cd my-project
archgate init

# 2. Edit the generated ADR to document a real decision
# .archgate/adrs/ARCH-001-*.md

# 3. Add a companion .rules.ts to enforce it automatically
# .archgate/adrs/ARCH-001-*.rules.ts

# 4. Run checks
archgate check

Writing rules

Each ADR can have a companion .rules.ts file that exports automated checks. See the writing rules guide for examples and the full rule API reference.

Supercharge with AI plugins

Make your AI agent architecture-aware. With the optional editor plugins, your AI coding agent reads ADRs before writing code, validates changes against your rules, and captures new architectural patterns back into ADRs, automatically.

Plugins are available for Claude Code and Cursor.

archgate login             # one-time GitHub auth
archgate init              # installs the plugin automatically

Get started with plugins. The CLI works fully without them, but plugins close the loop between decisions and code.

Documentation

Full documentation is available at cli.archgate.dev, including guides for writing ADRs, writing rules, CI integration, editor plugin setup, and the complete CLI reference.

Contributing

See CONTRIBUTING.md for development setup and workflow.

License

Apache-2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

archgate-0.50.0.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

archgate-0.50.0-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

Details for the file archgate-0.50.0.tar.gz.

File metadata

  • Download URL: archgate-0.50.0.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for archgate-0.50.0.tar.gz
Algorithm Hash digest
SHA256 4bb600c98a822638cc9bb419de62bc2750848ad27ce640a2a14acea394e48f76
MD5 7cfeada3f673b0fe91eedfc7442c6567
BLAKE2b-256 a0c6e671ea7e28163d32c59c78800a81795a1463a857452e528e09b549ab0152

See more details on using hashes here.

Provenance

The following attestation bundles were made for archgate-0.50.0.tar.gz:

Publisher: publish-shims.yml on archgate/cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file archgate-0.50.0-py3-none-any.whl.

File metadata

  • Download URL: archgate-0.50.0-py3-none-any.whl
  • Upload date:
  • Size: 10.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for archgate-0.50.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a1129b5307ca82a4fe880c9c843b4f0bca23df42eb4e442e0d98ade88280bcc0
MD5 b95eed0b6e3db3741c6c1579c047f529
BLAKE2b-256 ddbe6e1119390e66e5594631c5d597bf503c7af4f45b12a2230e22718b296a38

See more details on using hashes here.

Provenance

The following attestation bundles were made for archgate-0.50.0-py3-none-any.whl:

Publisher: publish-shims.yml on archgate/cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page