Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<div align="center">

**Enforce Architecture Decision Records as executable rules — for both humans and AI agents.**
**Enterprise-grade linting and guardrails for AI work.**

[![License: Apache-2.0](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](LICENSE.md)
[![Release](https://github.com/archgate/cli/actions/workflows/release.yml/badge.svg)](https://github.com/archgate/cli/actions/workflows/release.yml)
Expand All @@ -13,7 +13,7 @@

---

Archgate turns your Architecture Decision Records into a governance layer that runs in CI, enforces rules in pre-commit hooks, and feeds live context to AI coding agents — so architectural decisions don't stay in documents, they stay in the code.
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.**

Expand Down
13 changes: 6 additions & 7 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ export default defineConfig({
"pt-br": { label: "Português (Brasil)", lang: "pt-BR" },
nb: { label: "Norsk (Bokmål)", lang: "nb" },
},
description:
"Enforce Architecture Decision Records as executable rules — for both humans and AI agents.",
description: "Enterprise-grade linting and guardrails for AI work.",
customCss: ["./src/styles/custom.css"],
expressiveCode: {
// Use the pure-JS regex engine instead of the WASM-based oniguruma
Expand Down Expand Up @@ -133,7 +132,7 @@ export default defineConfig({
attrs: {
property: "og:image:alt",
content:
"Archgate — Architecture Decision Records as Executable Rules",
"Archgate — Enterprise-grade linting and guardrails for AI work",
},
},
// ── Twitter / X card ──────────────────────────────────────
Expand All @@ -156,7 +155,7 @@ export default defineConfig({
attrs: {
name: "keywords",
content:
"archgate, architecture decision records, ADR, executable rules, code governance, AI governance, TypeScript rules, CLI, compliance automation",
"archgate, linting, guardrails, AI coding, architecture decision records, ADR, executable rules, TypeScript rules, CLI, compliance automation",
},
},
// ── JSON-LD: WebSite ──────────────────────────────────────
Expand All @@ -169,7 +168,7 @@ export default defineConfig({
name: "Archgate CLI Documentation",
url: "https://cli.archgate.dev",
description:
"Documentation for Archgate — enforce Architecture Decision Records as executable TypeScript rules for automated code governance.",
"Documentation for Archgate — enterprise-grade linting and guardrails for AI work.",
inLanguage: ["en", "pt-BR", "nb"],
}),
},
Expand All @@ -182,15 +181,15 @@ export default defineConfig({
"@type": "SoftwareApplication",
name: "Archgate CLI",
applicationCategory: "DeveloperApplication",
applicationSubCategory: "Code Governance",
applicationSubCategory: "Code Linting",
operatingSystem: "macOS, Linux, Windows",
softwareVersion: "0.45.2",
license: "https://github.com/archgate/cli/blob/main/LICENSE",
offers: { "@type": "Offer", price: "0", priceCurrency: "USD" },
url: "https://cli.archgate.dev",
downloadUrl: "https://www.npmjs.com/package/archgate",
description:
"CLI tool that enforces Architecture Decision Records (ADRs) as executable TypeScript rules for automated code governance.",
"Enterprise-grade linting and guardrails for AI work. Enforce your team's architecture decisions as executable TypeScript rules.",
author: {
"@type": "Organization",
name: "Archgate",
Expand Down
34 changes: 17 additions & 17 deletions docs/public/llms-full.txt
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ When you run `archgate check`, the CLI loads every ADR that has `rules: true` in

## Editor plugins

The Archgate CLI works standalone, but **editor plugins** unlock a full AI governance workflow. Plugins give AI agents role-based skills so they read your ADRs before coding, validate after, and capture new patterns for your team -- automatically.
The Archgate CLI works standalone, but **editor plugins** unlock a full AI guardrails workflow. Plugins give AI agents role-based skills so they read your ADRs before coding, validate after, and capture new patterns for your team -- automatically.
Comment thread
coderabbitai[bot] marked this conversation as resolved.


The Claude Code plugin adds five skills: developer, architect,
Expand All @@ -101,7 +101,7 @@ The Archgate CLI works standalone, but **editor plugins** unlock a full AI gover


The Cursor plugin provides pre-built agent rules and skills that give
Cursor's AI agent the same governance workflow as Claude Code.
Cursor's AI agent the same guardrails workflow as Claude Code.


Editor plugins are currently in beta. Run `archgate login` to sign up and authenticate, then `archgate init --install-plugin` to set up the plugin.
Expand Down Expand Up @@ -323,9 +323,9 @@ If you prefer `npm install -g archgate` instead of the proto plugin, you need to

## Next steps

Once installed, run `archgate init` in your project to set up governance. See the [Quick Start](/getting-started/quick-start/) guide for a walkthrough.
Once installed, run `archgate init` in your project to set up linting and guardrails. See the [Quick Start](/getting-started/quick-start/) guide for a walkthrough.

Want your AI agent to read ADRs before coding and validate after? The editor plugins for [Claude Code](/guides/claude-code-plugin/) and [Cursor](/guides/cursor-integration/) add a full governance workflow on top of the CLI. Run `archgate login` to sign up and get started.
Want your AI agent to read ADRs before coding and validate after? The editor plugins for [Claude Code](/guides/claude-code-plugin/) and [Cursor](/guides/cursor-integration/) add a full guardrails workflow on top of the CLI. Run `archgate login` to sign up and get started.

---

Expand Down Expand Up @@ -468,7 +468,7 @@ Now that you have a working setup, dive deeper:

- [CI Integration](/guides/ci-integration/) — Wire `archgate check` into GitHub Actions, GitLab CI, or any pipeline.
- [Pre-commit Hooks](/guides/pre-commit-hooks/) — Run checks locally before every commit.
- [Claude Code Plugin](/guides/claude-code-plugin/) — Give AI agents a full governance workflow with role-based skills.
- [Claude Code Plugin](/guides/claude-code-plugin/) — Give AI agents architecture-aware guardrails with role-based skills.
- [Cursor Integration](/guides/cursor-integration/) — Use Archgate with Cursor IDE for AI-assisted development.

Want AI agents that automatically read your ADRs before coding? Run `archgate login` to sign up and authenticate, then run `archgate init --install-plugin` to set up the plugin.
Expand Down Expand Up @@ -1257,11 +1257,11 @@ CI catches violations at merge time. Editor plugins catch them at coding time. W

Source: https://cli.archgate.dev/guides/claude-code-plugin/

The Archgate Claude Code plugin gives AI agents working in [Claude Code](https://claude.ai/code) a structured governance workflow. Instead of relying on prompt instructions that drift over time, agents read your ADRs directly via Archgate CLI commands and validate their own code against your rules.
The Archgate Claude Code plugin gives AI agents working in [Claude Code](https://claude.ai/code) built-in guardrails. Instead of relying on prompt instructions that drift over time, agents read your ADRs directly via Archgate CLI commands and validate their own code against your rules.

## What the plugin provides

The plugin adds an agent and role-based skills to Claude Code. The agent orchestrates the governance workflow, invoking skills as needed -- read decisions before coding, validate after, and capture new patterns for the team.
The plugin adds an agent and role-based skills to Claude Code. The agent orchestrates the guardrails workflow, invoking skills as needed -- read decisions before coding, validate after, and capture new patterns for the team.

### Agent

Expand Down Expand Up @@ -1410,7 +1410,7 @@ The `archgate:developer` agent orchestrates the skills automatically -- it invok

Source: https://cli.archgate.dev/guides/copilot-cli-plugin/

The Archgate Copilot CLI plugin gives AI agents working in [GitHub Copilot CLI](https://github.com/features/copilot) a structured governance workflow. Agents read your ADRs before writing code, validate after, and capture new patterns for the team -- the same workflow available in the [Claude Code plugin](/guides/claude-code-plugin/).
The Archgate Copilot CLI plugin gives AI agents working in [GitHub Copilot CLI](https://github.com/features/copilot) built-in guardrails. Agents read your ADRs before writing code, validate after, and capture new patterns for the team -- the same workflow available in the [Claude Code plugin](/guides/claude-code-plugin/).

## How it works

Expand Down Expand Up @@ -1474,7 +1474,7 @@ You can find your authenticated URL by running `archgate plugin url copilot`.

## What the plugin provides

The plugin adds an agent and role-based skills to Copilot CLI. The agent orchestrates the governance workflow, invoking skills as needed.
The plugin adds an agent and role-based skills to Copilot CLI. The agent orchestrates the guardrails workflow, invoking skills as needed.

### Agent

Expand Down Expand Up @@ -1539,7 +1539,7 @@ The agent invokes `archgate:quality-manager` to review the work and identify pat

Source: https://cli.archgate.dev/guides/cursor-integration/

Archgate integrates with [Cursor](https://cursor.com) to give AI agents a structured governance workflow. The agent reads your ADRs before writing code, validates after, and captures new patterns for the team -- the same workflow available in the [Claude Code plugin](/guides/claude-code-plugin/).
Archgate integrates with [Cursor](https://cursor.com) to give AI agents built-in guardrails. The agent reads your ADRs before writing code, validates after, and captures new patterns for the team -- the same workflow available in the [Claude Code plugin](/guides/claude-code-plugin/).

## Setup

Expand All @@ -1551,7 +1551,7 @@ archgate init --editor cursor

The Cursor plugin is currently in beta. Run `archgate login` to sign up and authenticate.

If you have logged in via `archgate login`, the init command also installs the Archgate plugin for Cursor. The plugin provides pre-built agents, skills, and hooks that give Cursor's AI agent a full governance workflow.
If you have logged in via `archgate login`, the init command also installs the Archgate plugin for Cursor. The plugin provides pre-built agents, skills, and hooks that give Cursor's AI agent a full guardrails workflow.

The plugin is distributed as an authenticated tarball. The CLI downloads it and extracts skills, agents, and hooks into `~/.cursor/`. No CLI detection is needed -- files are written directly to the Cursor user directory.

Expand Down Expand Up @@ -1579,7 +1579,7 @@ archgate plugin install --editor cursor
| `~/.cursor/skills/archgate-adr-author.md` | Creates and edits ADRs following project conventions |
| `~/.cursor/skills/archgate-onboard.md` | One-time setup: explores the codebase, interviews you, creates ADRs |
| `~/.cursor/skills/archgate-cli-reference.md` | Internal reference for AI agents with the Archgate CLI guide |
| `~/.cursor/agents/archgate-developer.md` | Primary development agent with the full ADR governance workflow |
| `~/.cursor/agents/archgate-developer.md` | Primary development agent with the full ADR guardrails workflow |
| `~/.cursor/agents/archgate-planner.md` | Planning agent for scoping and breaking down work |

**Project scope**:
Expand Down Expand Up @@ -1835,7 +1835,7 @@ This manifest lets you track provenance — where each imported ADR came from an

Source: https://cli.archgate.dev/guides/opencode-integration/

Archgate integrates with [opencode](https://opencode.ai) to give AI agents a structured governance workflow. The agent reads your ADRs before writing code, validates after, and captures new patterns for the team -- the same workflow available in the [Claude Code plugin](/guides/claude-code-plugin/).
Archgate integrates with [opencode](https://opencode.ai) to give AI agents built-in guardrails. The agent reads your ADRs before writing code, validates after, and captures new patterns for the team -- the same workflow available in the [Claude Code plugin](/guides/claude-code-plugin/).

## Setup

Expand All @@ -1860,7 +1860,7 @@ opencode uses the XDG Base Directory convention on every platform (via the `xdg-

The install step only runs when the `opencode` CLI is on your PATH. Archgate needs to confirm opencode is present before writing files into its user-scope config directory — otherwise the agents would sit in a location nothing reads. Install opencode from [opencode.ai](https://opencode.ai/docs/) first, then re-run `archgate init --editor opencode` or `archgate plugin install --editor opencode`.

If you have logged in via `archgate login` **and** `opencode` is on your PATH, the init command downloads and installs the Archgate agent bundle for opencode. The bundle provides a pre-built primary agent and four subagents that give opencode's AI a full governance workflow.
If you have logged in via `archgate login` **and** `opencode` is on your PATH, the init command downloads and installs the Archgate agent bundle for opencode. The bundle provides a pre-built primary agent and four subagents that give opencode's AI a full guardrails workflow.

To explicitly install the agents:

Expand Down Expand Up @@ -2211,7 +2211,7 @@ If you discover a security issue in Archgate, please report it responsibly by op

Source: https://cli.archgate.dev/guides/vscode-plugin/

The Archgate VS Code plugin gives AI agents working in [VS Code](https://code.visualstudio.com/) a structured governance workflow. Agents read your ADRs before writing code, validate after, and capture new patterns for the team -- the same workflow available in the [Claude Code plugin](/guides/claude-code-plugin/).
The Archgate VS Code plugin gives AI agents working in [VS Code](https://code.visualstudio.com/) built-in guardrails. Agents read your ADRs before writing code, validate after, and capture new patterns for the team -- the same workflow available in the [Claude Code plugin](/guides/claude-code-plugin/).

## How it works

Expand Down Expand Up @@ -2245,7 +2245,7 @@ archgate init --editor vscode

If you are already logged in, this command:

1. Creates the `.archgate/` governance directory (ADRs, lint rules)
1. Creates the `.archgate/` directory with ADRs and lint rules
2. Adds the authenticated marketplace URL to your VS Code **user settings**
3. Downloads and installs the Archgate VS Code extension (`.vsix`) if the `code` CLI is available

Expand Down Expand Up @@ -2310,7 +2310,7 @@ Replace `<token>` with your archgate token (retrieve it via `archgate plugin url

## What the plugin provides

The plugin adds an agent and role-based skills to VS Code's AI. The agent orchestrates the governance workflow, invoking skills as needed.
The plugin adds an agent and role-based skills to VS Code's AI. The agent orchestrates the guardrails workflow, invoking skills as needed.

### Agent

Expand Down
4 changes: 2 additions & 2 deletions docs/src/content/docs/getting-started/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -214,8 +214,8 @@ If you prefer `npm install -g archgate` instead of the proto plugin, you need to

## Next steps

Once installed, run `archgate init` in your project to set up governance. See the [Quick Start](/getting-started/quick-start/) guide for a walkthrough.
Once installed, run `archgate init` in your project to set up linting and guardrails. See the [Quick Start](/getting-started/quick-start/) guide for a walkthrough.

:::tip[Editor plugins (beta)]
Want your AI agent to read ADRs before coding and validate after? The editor plugins for [Claude Code](/guides/claude-code-plugin/) and [Cursor](/guides/cursor-integration/) add a full governance workflow on top of the CLI. Run `archgate login` to sign up and get started.
Want your AI agent to read ADRs before coding and validate after? The editor plugins for [Claude Code](/guides/claude-code-plugin/) and [Cursor](/guides/cursor-integration/) add a full guardrails workflow on top of the CLI. Run `archgate login` to sign up and get started.
:::
2 changes: 1 addition & 1 deletion docs/src/content/docs/getting-started/quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ Now that you have a working setup, dive deeper:

- [CI Integration](/guides/ci-integration/) — Wire `archgate check` into GitHub Actions, GitLab CI, or any pipeline.
- [Pre-commit Hooks](/guides/pre-commit-hooks/) — Run checks locally before every commit.
- [Claude Code Plugin](/guides/claude-code-plugin/) — Give AI agents a full governance workflow with role-based skills.
- [Claude Code Plugin](/guides/claude-code-plugin/) — Give AI agents architecture-aware guardrails with role-based skills.
- [Cursor Integration](/guides/cursor-integration/) — Use Archgate with Cursor IDE for AI-assisted development.

:::tip[Editor plugins (beta)]
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/guides/ci-integration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,6 @@ Use `--verbose` to see passing rules and timing information alongside failures.
- run: archgate check --verbose
```

:::tip[Add AI governance to your workflow]
:::tip[Add AI guardrails to your workflow]
CI catches violations at merge time. Editor plugins catch them at coding time. With the [Claude Code](/guides/claude-code-plugin/) or [Cursor](/guides/cursor-integration/) plugin, your AI agent reads ADRs before writing code and validates compliance before you even commit. [Sign up for beta access](https://plugins.archgate.dev).
:::
6 changes: 3 additions & 3 deletions docs/src/content/docs/guides/claude-code-plugin.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: Claude Code Plugin
description: Set up the Archgate plugin for Claude Code. Give AI agents a governance workflow that reads ADRs, validates code, and captures architectural patterns.
description: Set up the Archgate plugin for Claude Code. Give AI agents guardrails that read ADRs, validate code, and capture architectural patterns.
---

The Archgate Claude Code plugin gives AI agents working in [Claude Code](https://claude.ai/code) a structured governance workflow. Instead of relying on prompt instructions that drift over time, agents read your ADRs directly via Archgate CLI commands and validate their own code against your rules.
The Archgate Claude Code plugin gives AI agents working in [Claude Code](https://claude.ai/code) built-in guardrails. Instead of relying on prompt instructions that drift over time, agents read your ADRs directly via Archgate CLI commands and validate their own code against your rules.

## What the plugin provides

The plugin adds an agent and role-based skills to Claude Code. The agent orchestrates the governance workflow, invoking skills as needed -- read decisions before coding, validate after, and capture new patterns for the team.
The plugin adds an agent and role-based skills to Claude Code. The agent orchestrates the guardrails workflow, invoking skills as needed -- read decisions before coding, validate after, and capture new patterns for the team.

### Agent

Expand Down
Loading
Loading