archgate 0.6.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +198 -102
- package/README.md +34 -227
- package/package.json +3 -3
package/LICENSE.md
CHANGED
|
@@ -1,105 +1,201 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
and
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Archgate
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
98
193
|
You may obtain a copy of the License at
|
|
99
194
|
|
|
100
|
-
http://www.apache.org/licenses/LICENSE-2.0
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
101
196
|
|
|
102
|
-
Unless required by applicable law or agreed to in writing, software
|
|
103
|
-
under the License is distributed on an "AS IS" BASIS,
|
|
104
|
-
CONDITIONS OF ANY KIND, either express or implied.
|
|
105
|
-
specific language governing permissions and
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
**Enforce Architecture Decision Records as executable rules — for both humans and AI agents.**
|
|
6
6
|
|
|
7
|
-
[](LICENSE.md)
|
|
8
8
|
[](https://github.com/archgate/cli/actions/workflows/release.yml)
|
|
9
9
|
[](https://cli.archgate.dev)
|
|
10
10
|
|
|
@@ -36,8 +36,6 @@ When a rule is violated, `archgate check` reports the file, line, and which ADR
|
|
|
36
36
|
|
|
37
37
|
**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.
|
|
38
38
|
|
|
39
|
-
**Editor plugins are an optional paid add-on** for teams that want AI agents (Claude Code, Cursor) to read ADRs, validate changes, and capture new patterns automatically. Plugins are distributed from [plugins.archgate.dev](https://plugins.archgate.dev). See [Editor plugins](#editor-plugins) for details.
|
|
40
|
-
|
|
41
39
|
## Installation
|
|
42
40
|
|
|
43
41
|
```bash
|
|
@@ -54,31 +52,14 @@ yarn global add archgate
|
|
|
54
52
|
pnpm add -g archgate
|
|
55
53
|
```
|
|
56
54
|
|
|
57
|
-
You can also install
|
|
55
|
+
You can also install as a dev dependency:
|
|
58
56
|
|
|
59
57
|
```bash
|
|
60
|
-
# Install as dev dependency
|
|
61
58
|
npm install -D archgate # or: bun add -d archgate
|
|
62
|
-
|
|
63
|
-
# Run via package manager
|
|
64
|
-
npx archgate check # npm / Yarn / pnpm
|
|
65
|
-
bun run archgate check # Bun
|
|
59
|
+
npx archgate check # run via package manager
|
|
66
60
|
```
|
|
67
61
|
|
|
68
|
-
**Requirements:** macOS (arm64), Linux (x86_64), or Windows (x86_64).
|
|
69
|
-
|
|
70
|
-
> **Using [proto](https://moonrepo.dev/proto)?** Add the following to `~/.proto/config.toml` and your shell profile so globals persist across Node.js version switches:
|
|
71
|
-
>
|
|
72
|
-
> ```toml
|
|
73
|
-
> # ~/.proto/config.toml
|
|
74
|
-
> [tools.npm]
|
|
75
|
-
> shared-globals-dir = true
|
|
76
|
-
> ```
|
|
77
|
-
>
|
|
78
|
-
> ```sh
|
|
79
|
-
> # ~/.zshrc or ~/.bashrc
|
|
80
|
-
> export PATH="$HOME/.proto/tools/node/globals/bin:$PATH"
|
|
81
|
-
> ```
|
|
62
|
+
**Requirements:** macOS (arm64), Linux (x86_64), or Windows (x86_64). See the [installation guide](https://cli.archgate.dev/getting-started/installation/) for more options.
|
|
82
63
|
|
|
83
64
|
## Quick start
|
|
84
65
|
|
|
@@ -100,223 +81,49 @@ archgate init
|
|
|
100
81
|
archgate check
|
|
101
82
|
```
|
|
102
83
|
|
|
103
|
-
`archgate init` creates the `.archgate/adrs/` directory with an example ADR and rules file, and configures editor settings. No account or login is needed — the CLI is fully functional without plugins.
|
|
104
|
-
|
|
105
|
-
**Want AI agent integration?** See [Editor plugins](#editor-plugins) to add the optional paid plugin for Claude Code or Cursor.
|
|
106
|
-
|
|
107
84
|
## Writing rules
|
|
108
85
|
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
```typescript
|
|
112
|
-
// .archgate/adrs/ARCH-002-error-handling.rules.ts
|
|
113
|
-
import { defineRules } from "archgate/rules";
|
|
114
|
-
|
|
115
|
-
export default defineRules([
|
|
116
|
-
{
|
|
117
|
-
id: "use-log-error",
|
|
118
|
-
description:
|
|
119
|
-
"Use logError() instead of console.error() for user-facing errors",
|
|
120
|
-
severity: "error",
|
|
121
|
-
async check({ files }) {
|
|
122
|
-
const violations = [];
|
|
123
|
-
for (const file of files) {
|
|
124
|
-
const content = await Bun.file(file).text();
|
|
125
|
-
const lines = content.split("\n");
|
|
126
|
-
lines.forEach((line, i) => {
|
|
127
|
-
if (line.includes("console.error(")) {
|
|
128
|
-
violations.push({
|
|
129
|
-
file,
|
|
130
|
-
line: i + 1,
|
|
131
|
-
message: "Use logError() instead",
|
|
132
|
-
});
|
|
133
|
-
}
|
|
134
|
-
});
|
|
135
|
-
}
|
|
136
|
-
return violations;
|
|
137
|
-
},
|
|
138
|
-
},
|
|
139
|
-
]);
|
|
140
|
-
```
|
|
86
|
+
Each ADR can have a companion `.rules.ts` file that exports checks using `defineRules()` from the `archgate` package. Rules receive the list of files to check and return an array of violations with file paths and line numbers.
|
|
141
87
|
|
|
142
|
-
|
|
88
|
+
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/).
|
|
143
89
|
|
|
144
90
|
## Commands
|
|
145
91
|
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
archgate
|
|
152
|
-
archgate
|
|
153
|
-
archgate
|
|
154
|
-
archgate login
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
### `archgate init`
|
|
160
|
-
|
|
161
|
-
Initialize governance in the current project.
|
|
162
|
-
|
|
163
|
-
```bash
|
|
164
|
-
archgate init # Claude Code (default)
|
|
165
|
-
archgate init --editor cursor # Cursor
|
|
166
|
-
archgate init --install-plugin # force plugin install attempt
|
|
167
|
-
```
|
|
168
|
-
|
|
169
|
-
Creates `.archgate/adrs/` with an example ADR and rules file and configures editor settings. Works without an account — plugin installation only happens when you are logged in.
|
|
170
|
-
|
|
171
|
-
**Plugin install behavior** (optional — requires `archgate login`):
|
|
172
|
-
|
|
173
|
-
- If you are logged in, init auto-detects your credentials and installs the plugin.
|
|
174
|
-
- For **Claude Code**: if the `claude` CLI is on PATH, the plugin is installed automatically via `claude plugin marketplace add` and `claude plugin install`. If not, the manual commands are printed.
|
|
175
|
-
- For **Cursor**: the plugin bundle is downloaded from [plugins.archgate.dev](https://plugins.archgate.dev) and extracted into `.cursor/`.
|
|
176
|
-
- Use `--install-plugin` to explicitly request plugin installation (useful if auto-detection is skipped).
|
|
177
|
-
|
|
178
|
-
### `archgate check`
|
|
179
|
-
|
|
180
|
-
Run all automated ADR checks against your codebase.
|
|
181
|
-
|
|
182
|
-
```bash
|
|
183
|
-
archgate check # check all files
|
|
184
|
-
archgate check --staged # check only git-staged files (for pre-commit hooks)
|
|
185
|
-
archgate check --json # machine-readable JSON output
|
|
186
|
-
```
|
|
187
|
-
|
|
188
|
-
Exits with code 0 if all checks pass, 1 if any violations are found.
|
|
189
|
-
|
|
190
|
-
### `archgate adr create`
|
|
191
|
-
|
|
192
|
-
Create a new ADR interactively.
|
|
193
|
-
|
|
194
|
-
```bash
|
|
195
|
-
archgate adr create
|
|
196
|
-
```
|
|
197
|
-
|
|
198
|
-
Prompts for a title, domain, and optional file glob. Generates a sequential ID (`ARCH-001`, `ARCH-002`, ...) and writes the markdown file.
|
|
199
|
-
|
|
200
|
-
### `archgate adr list`
|
|
201
|
-
|
|
202
|
-
List all ADRs in the project.
|
|
203
|
-
|
|
204
|
-
```bash
|
|
205
|
-
archgate adr list # table output
|
|
206
|
-
archgate adr list --json # JSON output
|
|
207
|
-
archgate adr list --domain backend # filter by domain
|
|
208
|
-
```
|
|
209
|
-
|
|
210
|
-
### `archgate adr show <id>`
|
|
211
|
-
|
|
212
|
-
Print a specific ADR.
|
|
213
|
-
|
|
214
|
-
```bash
|
|
215
|
-
archgate adr show ARCH-001
|
|
216
|
-
```
|
|
217
|
-
|
|
218
|
-
### `archgate adr update`
|
|
92
|
+
| Command | Description |
|
|
93
|
+
| ------------------------ | ---------------------------------------------------------- |
|
|
94
|
+
| `archgate init` | Initialize `.archgate/` with example ADR and editor config |
|
|
95
|
+
| `archgate check` | Run ADR compliance checks (`--staged` for pre-commit) |
|
|
96
|
+
| `archgate adr create` | Create a new ADR interactively |
|
|
97
|
+
| `archgate adr list` | List all ADRs (`--json`, `--domain`) |
|
|
98
|
+
| `archgate adr show <id>` | Print a specific ADR |
|
|
99
|
+
| `archgate adr update` | Update an ADR's frontmatter |
|
|
100
|
+
| `archgate login` | Authenticate with GitHub for editor plugins |
|
|
101
|
+
| `archgate mcp` | Start the MCP server for AI agent integration |
|
|
102
|
+
| `archgate upgrade` | Upgrade to the latest release |
|
|
103
|
+
| `archgate clean` | Remove the CLI cache (`~/.archgate/`) |
|
|
219
104
|
|
|
220
|
-
|
|
105
|
+
See the [CLI reference](https://cli.archgate.dev/reference/cli-commands/) for full usage and options.
|
|
221
106
|
|
|
222
|
-
|
|
223
|
-
archgate adr update ARCH-001 --title "New Title" --domain backend
|
|
224
|
-
```
|
|
225
|
-
|
|
226
|
-
### `archgate mcp`
|
|
227
|
-
|
|
228
|
-
Start the MCP server for AI agent integration.
|
|
229
|
-
|
|
230
|
-
```bash
|
|
231
|
-
archgate mcp
|
|
232
|
-
```
|
|
233
|
-
|
|
234
|
-
Exposes five tools to MCP-compatible clients (Claude Code, Cursor, etc.):
|
|
235
|
-
|
|
236
|
-
| Tool | Description |
|
|
237
|
-
| ----------------------------- | ----------------------------------------------------------------- |
|
|
238
|
-
| `check` | Run ADR compliance checks, optionally on staged files only |
|
|
239
|
-
| `list_adrs` | List all ADRs with metadata |
|
|
240
|
-
| `review_context` | Get changed files grouped by domain with applicable ADR briefings |
|
|
241
|
-
| `claude_code_session_context` | Read the current Claude Code session transcript |
|
|
242
|
-
| `cursor_session_context` | Read Cursor agent session transcripts |
|
|
243
|
-
|
|
244
|
-
Also exposes `adr://{id}` resources for reading individual ADRs by ID.
|
|
245
|
-
|
|
246
|
-
### `archgate upgrade`
|
|
247
|
-
|
|
248
|
-
Upgrade to the latest release.
|
|
249
|
-
|
|
250
|
-
```bash
|
|
251
|
-
npm update -g archgate
|
|
252
|
-
```
|
|
253
|
-
|
|
254
|
-
### `archgate clean`
|
|
255
|
-
|
|
256
|
-
Remove the CLI cache directory (`~/.archgate/`).
|
|
257
|
-
|
|
258
|
-
```bash
|
|
259
|
-
archgate clean
|
|
260
|
-
```
|
|
261
|
-
|
|
262
|
-
## CI integration
|
|
263
|
-
|
|
264
|
-
Add a check step to your pipeline:
|
|
265
|
-
|
|
266
|
-
```yaml
|
|
267
|
-
# GitHub Actions example
|
|
268
|
-
- name: ADR compliance check
|
|
269
|
-
run: archgate check
|
|
270
|
-
```
|
|
271
|
-
|
|
272
|
-
For pre-commit hooks (using [lefthook](https://github.com/evilmartians/lefthook) or similar):
|
|
273
|
-
|
|
274
|
-
```yaml
|
|
275
|
-
pre-commit:
|
|
276
|
-
commands:
|
|
277
|
-
adr-check:
|
|
278
|
-
run: archgate check --staged
|
|
279
|
-
```
|
|
280
|
-
|
|
281
|
-
## Editor plugins
|
|
282
|
-
|
|
283
|
-
> **Plugins are an optional paid add-on.** The CLI works fully without them. Plugins add AI agent integration — your AI coding agent reads ADRs before writing code, validates changes after implementation, and captures new patterns back into ADRs.
|
|
284
|
-
|
|
285
|
-
Plugins are distributed from [plugins.archgate.dev](https://plugins.archgate.dev).
|
|
286
|
-
|
|
287
|
-
### Setup
|
|
288
|
-
|
|
289
|
-
```bash
|
|
290
|
-
# 1. Log in (one-time) — links your GitHub account and issues a plugin token
|
|
291
|
-
archgate login
|
|
292
|
-
|
|
293
|
-
# 2. Initialize a project with the plugin
|
|
294
|
-
archgate init # Claude Code (default)
|
|
295
|
-
archgate init --editor cursor # or Cursor
|
|
296
|
-
```
|
|
107
|
+
## CI and pre-commit hooks
|
|
297
108
|
|
|
298
|
-
|
|
109
|
+
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.
|
|
299
110
|
|
|
300
|
-
|
|
111
|
+
## Supercharge with AI plugins
|
|
301
112
|
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
The Cursor plugin bundle is downloaded from [plugins.archgate.dev](https://plugins.archgate.dev) and extracted into `.cursor/` automatically.
|
|
314
|
-
|
|
315
|
-
Once installed, run the `ag-onboard` skill in Cursor to initialize governance for your project.
|
|
113
|
+
> **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.
|
|
114
|
+
>
|
|
115
|
+
> Plugins are available for [**Claude Code**](https://cli.archgate.dev/guides/claude-code-plugin/) and [**Cursor**](https://cli.archgate.dev/guides/cursor-integration/).
|
|
116
|
+
>
|
|
117
|
+
> ```bash
|
|
118
|
+
> archgate login # one-time GitHub auth
|
|
119
|
+
> archgate init # installs the plugin automatically
|
|
120
|
+
> ```
|
|
121
|
+
>
|
|
122
|
+
> **[Get started with plugins](https://cli.archgate.dev/guides/claude-code-plugin/)** — the CLI works fully without them, but plugins close the loop between decisions and code.
|
|
316
123
|
|
|
317
124
|
## Documentation
|
|
318
125
|
|
|
319
|
-
Full documentation is available at **[cli.archgate.dev](https://cli.archgate.dev)**
|
|
126
|
+
Full documentation is available at **[cli.archgate.dev](https://cli.archgate.dev)** — including guides for writing ADRs, writing rules, CI integration, editor plugin setup, and the complete CLI and MCP reference.
|
|
320
127
|
|
|
321
128
|
## Contributing
|
|
322
129
|
|
|
@@ -324,4 +131,4 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and workflow.
|
|
|
324
131
|
|
|
325
132
|
## License
|
|
326
133
|
|
|
327
|
-
[
|
|
134
|
+
[Apache-2.0](LICENSE.md)
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "archgate",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.8.0",
|
|
4
4
|
"description": "Enforce Architecture Decision Records as executable rules — for both humans and AI agents",
|
|
5
5
|
"readme": "README.md",
|
|
6
|
-
"license": "
|
|
7
|
-
"homepage": "https://archgate.dev",
|
|
6
|
+
"license": "Apache-2.0",
|
|
7
|
+
"homepage": "https://cli.archgate.dev",
|
|
8
8
|
"bin": {
|
|
9
9
|
"archgate": "bin/archgate.cjs"
|
|
10
10
|
},
|