You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: replace hardcoded content with source references (#88)
* docs: remove hardcoded versions and counts, point to source files
CLAUDE.md: replace command table, ADR list, and pinned versions with
references to src/commands/, .archgate/adrs/, and .prototools.
README.md: remove commands table and CI section, defer to docs site.
Homepage (en + pt-br): replace "Six ADRs" with open-ended text and
link to the ADRs directory on GitHub.
* docs: regenerate llms-full.txt
|`plugin install`|`commands/plugin/install.ts`| Install the archgate plugin for the specified editor |
54
-
|`plugin url`|`commands/plugin/url.ts`| Print the authenticated plugin repository URL |
55
-
|`upgrade`|`commands/upgrade.ts`| Upgrade Archgate to the latest version |
56
-
|`clean`|`commands/clean.ts`| Clean the CLI temp files |
34
+
Entry point: `src/cli.ts` (shebang `#!/usr/bin/env bun`). Commands registered via `register*Command(program)`. See `src/commands/` for all command implementations — each file exports a `register*Command(program)` function.
57
35
58
36
### Key Paths
59
37
@@ -75,24 +53,13 @@ Zod schemas are the single source of truth. Types derived via `z.infer<>` — ne
-`ARCH-010` — Prefer Bun built-in JSON parsing (Bun.file().json())
94
-
-`GEN-001` — Documentation site (Astro Starlight)
95
-
-`GEN-002` — Documentation internationalization (en + pt-br parity)
62
+
The CLI dogfoods itself — see `.archgate/adrs/` for the full list of ADRs and their companion `.rules.ts` files. Read them before making architectural changes.
Copy file name to clipboardExpand all lines: README.md
+1-23Lines changed: 1 addition & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -95,29 +95,7 @@ archgate check
95
95
96
96
## Writing rules
97
97
98
-
Each ADR can have a companion `.rules.ts` file that exports a plain object typed with `satisfies RuleSet`. Rules receive the list of files to check and return an array of violations with file paths and line numbers.
99
-
100
-
See the [writing rules guide](https://cli.archgate.dev/guides/writing-rules/) for examples and the full [rule API reference](https://cli.archgate.dev/reference/rule-api/).
|`archgate init`| Initialize `.archgate/` with example ADR and editor config |
107
-
|`archgate check`| Run ADR compliance checks (`--staged` for pre-commit) |
108
-
|`archgate adr create`| Create a new ADR interactively |
109
-
|`archgate adr list`| List all ADRs (`--json`, `--domain`) |
110
-
|`archgate adr show <id>`| Print a specific ADR |
111
-
|`archgate adr update`| Update an ADR's frontmatter |
112
-
|`archgate login`| Authenticate with GitHub for editor plugins |
113
-
|`archgate upgrade`| Upgrade to the latest release |
114
-
|`archgate clean`| Remove the CLI cache (`~/.archgate/`) |
115
-
116
-
See the [CLI reference](https://cli.archgate.dev/reference/cli-commands/) for full usage and options.
117
-
118
-
## CI and pre-commit hooks
119
-
120
-
Add `archgate check` to your CI pipeline or pre-commit hooks to block merges that violate ADRs. See the [CI integration guide](https://cli.archgate.dev/guides/ci-integration/) and [pre-commit hooks guide](https://cli.archgate.dev/guides/pre-commit-hooks/) for setup instructions.
98
+
Each ADR can have a companion `.rules.ts` file that exports automated checks. See the [writing rules guide](https://cli.archgate.dev/guides/writing-rules/) for examples and the full [rule API reference](https://cli.archgate.dev/reference/rule-api/).
0 commit comments