archgate 0.5.0 → 0.6.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/README.md +29 -3
- package/package.json +10 -4
package/README.md
CHANGED
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
[](LICENSE.md)
|
|
8
8
|
[](https://github.com/archgate/cli/actions/workflows/release.yml)
|
|
9
|
+
[](https://cli.archgate.dev)
|
|
9
10
|
|
|
10
11
|
</div>
|
|
11
12
|
|
|
@@ -40,10 +41,31 @@ When a rule is violated, `archgate check` reports the file, line, and which ADR
|
|
|
40
41
|
## Installation
|
|
41
42
|
|
|
42
43
|
```bash
|
|
44
|
+
# npm
|
|
43
45
|
npm install -g archgate
|
|
46
|
+
|
|
47
|
+
# Bun
|
|
48
|
+
bun install -g archgate
|
|
49
|
+
|
|
50
|
+
# Yarn
|
|
51
|
+
yarn global add archgate
|
|
52
|
+
|
|
53
|
+
# pnpm
|
|
54
|
+
pnpm add -g archgate
|
|
44
55
|
```
|
|
45
56
|
|
|
46
|
-
|
|
57
|
+
You can also install Archgate as a dev dependency and run it through your package manager:
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
# Install as dev dependency
|
|
61
|
+
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
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
**Requirements:** macOS (arm64), Linux (x86_64), or Windows (x86_64). Node.js is only needed to run the npm/yarn/pnpm wrapper — the CLI itself is a standalone binary.
|
|
47
69
|
|
|
48
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:
|
|
49
71
|
>
|
|
@@ -61,8 +83,8 @@ npm install -g archgate
|
|
|
61
83
|
## Quick start
|
|
62
84
|
|
|
63
85
|
```bash
|
|
64
|
-
# 1. Install
|
|
65
|
-
npm install -g archgate
|
|
86
|
+
# 1. Install (pick your package manager)
|
|
87
|
+
npm install -g archgate # or: bun install -g archgate
|
|
66
88
|
|
|
67
89
|
# 2. Initialize governance in your project
|
|
68
90
|
cd my-project
|
|
@@ -292,6 +314,10 @@ The Cursor plugin bundle is downloaded from [plugins.archgate.dev](https://plugi
|
|
|
292
314
|
|
|
293
315
|
Once installed, run the `ag-onboard` skill in Cursor to initialize governance for your project.
|
|
294
316
|
|
|
317
|
+
## Documentation
|
|
318
|
+
|
|
319
|
+
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
|
+
|
|
295
321
|
## Contributing
|
|
296
322
|
|
|
297
323
|
See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and workflow.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "archgate",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.6.0",
|
|
4
4
|
"description": "Enforce Architecture Decision Records as executable rules — for both humans and AI agents",
|
|
5
5
|
"readme": "README.md",
|
|
6
6
|
"license": "FSL-1.1-ALv2",
|
|
@@ -21,8 +21,11 @@
|
|
|
21
21
|
},
|
|
22
22
|
"keywords": [
|
|
23
23
|
"archgate",
|
|
24
|
-
"
|
|
25
|
-
"
|
|
24
|
+
"adr",
|
|
25
|
+
"architecture-decision-records",
|
|
26
|
+
"governance",
|
|
27
|
+
"linter",
|
|
28
|
+
"cli"
|
|
26
29
|
],
|
|
27
30
|
"bugs": {
|
|
28
31
|
"url": "https://github.com/archgate/cli/issues"
|
|
@@ -48,7 +51,10 @@
|
|
|
48
51
|
"build:check": "bun build src/cli.ts --compile --bytecode --outfile dist/.build-check && rm -f dist/.build-check dist/.build-check.exe",
|
|
49
52
|
"validate": "bun run lint && bun run typecheck && bun run format:check && bun test && bun run check && bun run build:check",
|
|
50
53
|
"commit": "cz",
|
|
51
|
-
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0"
|
|
54
|
+
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0",
|
|
55
|
+
"docs:dev": "cd docs && bunx --bun astro dev",
|
|
56
|
+
"docs:build": "cd docs && bunx --bun astro build",
|
|
57
|
+
"docs:preview": "cd docs && bunx --bun astro preview"
|
|
52
58
|
},
|
|
53
59
|
"type": "module",
|
|
54
60
|
"devDependencies": {
|