archgen-skill 0.0.1 → 0.0.2
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 +140 -0
- package/bin/archgen.mjs +1 -1
- package/package.json +5 -3
package/README.md
ADDED
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
# archgen-skill
|
|
4
|
+
|
|
5
|
+
**Conversational architecture generation & autonomous task execution for coding agents.**
|
|
6
|
+
|
|
7
|
+
[](https://github.com/akashmaurya99/archgen/actions/workflows/ci.yml)
|
|
8
|
+
[](https://github.com/akashmaurya99/archgen/blob/main/LICENSE)
|
|
9
|
+
[](https://nodejs.org)
|
|
10
|
+
|
|
11
|
+
Describe what you want to build. archgen interviews you (or surveys your existing
|
|
12
|
+
codebase), produces an architecture contract plus a dependency-ordered task graph,
|
|
13
|
+
verifies the plan, then executes it wave-by-wave through sub-agents.
|
|
14
|
+
|
|
15
|
+
Works as an agent skill for **Claude Code · OpenCode · Cursor · Codex · Gemini CLI ·
|
|
16
|
+
Antigravity** — and any [agentskills.io](https://agentskills.io)-compatible harness.
|
|
17
|
+
|
|
18
|
+
</div>
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## Install
|
|
23
|
+
|
|
24
|
+
**Prepare a project** (recommended) — copies the skill locally + writes
|
|
25
|
+
`AGENTS.md` / `CLAUDE.md` pointer blocks so every harness auto-discovers it:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
npx archgen-skill init
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
**Or install globally** into every detected harness:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
npx archgen-skill install # symlinks; --copy for real copies
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Prefer shell? Clone the repo and run `./install.sh` (same behavior, plus
|
|
38
|
+
`--init`, `--project`, `--uninstall`). Requires Node.js ≥ 18.
|
|
39
|
+
The skill itself has zero npm dependencies.
|
|
40
|
+
|
|
41
|
+
## Quick start
|
|
42
|
+
|
|
43
|
+
After `npx archgen-skill init`, open your project in any supported agent and talk naturally:
|
|
44
|
+
|
|
45
|
+
| You say | What runs |
|
|
46
|
+
| --- | --- |
|
|
47
|
+
| *"generate architecture for a booking platform"* | Interview → artifacts → both gates |
|
|
48
|
+
| *"add rate-limiting to my API server"* | Survey existing code first, then plan + gates |
|
|
49
|
+
| *"start work"* | Autonomous wave execution until done or blocked |
|
|
50
|
+
| *"roll back the auth changes"* | Impact analysis → reverse-order revert plan → approval |
|
|
51
|
+
|
|
52
|
+
Everything archgen produces lives in one reviewable `.archgen/<slug>/` folder —
|
|
53
|
+
architecture contract, docs, ADRs, plans, and a `tasks.yaml` task graph — versioned by git.
|
|
54
|
+
|
|
55
|
+
## Commands
|
|
56
|
+
|
|
57
|
+
| Command | What it does |
|
|
58
|
+
| --- | --- |
|
|
59
|
+
| `npx archgen-skill init [dir]` | Copy the skill into `.agents/skills/archgen` + `.claude/skills/archgen` and write AGENTS.md / CLAUDE.md pointer blocks |
|
|
60
|
+
| `npx archgen-skill install [--copy]` | Install into global harness skill dirs (symlinks by default, real copies with `--copy`) |
|
|
61
|
+
| `npx archgen-skill uninstall` | Remove globally-installed copies (manifest-recorded, safe removal) |
|
|
62
|
+
| `npx archgen-skill --help` | Help |
|
|
63
|
+
|
|
64
|
+
## Why archgen
|
|
65
|
+
|
|
66
|
+
AI coding agents fail at scale for predictable reasons: plans with hidden cycles,
|
|
67
|
+
workers editing the same files, tasks without objective acceptance criteria, and no
|
|
68
|
+
human checkpoint before execution. archgen makes each of these a *structural*
|
|
69
|
+
guarantee rather than a hope:
|
|
70
|
+
|
|
71
|
+
| Guarantee | Mechanism |
|
|
72
|
+
| --- | --- |
|
|
73
|
+
| Plans are valid before work starts | Verifier gate — catches cycles, dangling refs, ownership overlaps, plan↔task coverage gaps |
|
|
74
|
+
| You approve before code is written | Explicit user gate after verifier approval |
|
|
75
|
+
| Parallel workers never collide | Disjoint `file_ownership` globs enforced per wave |
|
|
76
|
+
| Task order is always correct | Topological waves from `depends_on`; chains stay sequential |
|
|
77
|
+
| Failures never cascade silently | Failed tasks exclude downstream into `blockedByFailure`, surfaced to you |
|
|
78
|
+
| Every artifact is reviewable | Everything in one `.archgen/<slug>/` folder, versioned by git |
|
|
79
|
+
|
|
80
|
+
```text
|
|
81
|
+
interview (greenfield) · survey (brownfield)
|
|
82
|
+
│
|
|
83
|
+
▼
|
|
84
|
+
.archgen/<slug>/ ── architecture.yaml · docs · ADRs · plans · tasks.yaml
|
|
85
|
+
│
|
|
86
|
+
▼
|
|
87
|
+
VERIFIER GATE ──issues──► fix & re-verify
|
|
88
|
+
│ APPROVE
|
|
89
|
+
▼
|
|
90
|
+
USER GATE ────reject───► revise
|
|
91
|
+
│ approve
|
|
92
|
+
▼
|
|
93
|
+
WAVES ── topological order · one sub-agent per task · disjoint ownership
|
|
94
|
+
│
|
|
95
|
+
▼
|
|
96
|
+
final report: done / failed / blocked · commits · follow-ups
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
## Supported harnesses
|
|
100
|
+
|
|
101
|
+
| Harness | Global install | Project-local (`init`) |
|
|
102
|
+
| --- | --- | --- |
|
|
103
|
+
| Claude Code | ✅ | ✅ |
|
|
104
|
+
| OpenCode | ✅ | ✅ |
|
|
105
|
+
| Cursor | ✅ | ✅ |
|
|
106
|
+
| Codex | ✅ | ✅ |
|
|
107
|
+
| Gemini CLI | ✅ | ✅ |
|
|
108
|
+
| Antigravity | ✅ | ✅ |
|
|
109
|
+
| Any agentskills.io harness | ✅ | ✅ |
|
|
110
|
+
|
|
111
|
+
## VS Code extension (optional)
|
|
112
|
+
|
|
113
|
+
A read-only visual layer that renders `.archgen/` as a live task DAG (running tasks
|
|
114
|
+
pulse, edges animate), your code-dependency graph, and rendered docs — with a ▶
|
|
115
|
+
button that launches your agent on any task. Install the `.vsix` from
|
|
116
|
+
[GitHub Releases](https://github.com/akashmaurya99/archgen/releases). It is strictly
|
|
117
|
+
a viewer: uninstalling it loses nothing.
|
|
118
|
+
|
|
119
|
+
## Documentation
|
|
120
|
+
|
|
121
|
+
| Doc | Contents |
|
|
122
|
+
| --- | --- |
|
|
123
|
+
| [Architecture walkthrough](https://github.com/akashmaurya99/archgen/blob/main/docs/architecture.md) | Dual-mode design, gates, wave mechanics, platform detection |
|
|
124
|
+
| [The skill contract](https://github.com/akashmaurya99/archgen/blob/main/skill/SKILL.md) | The full skill specification agents execute |
|
|
125
|
+
| [Changelog](https://github.com/akashmaurya99/archgen/blob/main/CHANGELOG.md) | Release history |
|
|
126
|
+
| [Contributing](https://github.com/akashmaurya99/archgen/blob/main/CONTRIBUTING.md) | Development setup and PR guide |
|
|
127
|
+
|
|
128
|
+
## Contributing
|
|
129
|
+
|
|
130
|
+
See [CONTRIBUTING.md](https://github.com/akashmaurya99/archgen/blob/main/CONTRIBUTING.md).
|
|
131
|
+
Skill suite and CLI tests run with zero dependencies:
|
|
132
|
+
|
|
133
|
+
```sh
|
|
134
|
+
node --test skill/scripts/test/*.test.mjs # skill suite
|
|
135
|
+
cd packages/cli && npm test # CLI suite
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
## License
|
|
139
|
+
|
|
140
|
+
[MIT](https://github.com/akashmaurya99/archgen/blob/main/LICENSE) © ArchGen contributors
|
package/bin/archgen.mjs
CHANGED
package/package.json
CHANGED
|
@@ -1,14 +1,16 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "archgen-skill",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.2",
|
|
4
4
|
"description": "Architecture generation & autonomous task execution for coding agents - conversational requirements in, dependency-ordered tasks out, executed wave-by-wave with verifier gates. Works with Claude Code, OpenCode, Cursor, Codex, Gemini CLI and any agentskills.io harness.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
7
|
-
"bin": { "archgen": "bin/archgen.mjs" },
|
|
7
|
+
"bin": { "archgen-skill": "bin/archgen.mjs" },
|
|
8
8
|
"files": ["bin/", "lib/", "vendor/", "README.md"],
|
|
9
9
|
"engines": { "node": ">=18" },
|
|
10
|
-
"keywords": ["ai", "agents", "
|
|
10
|
+
"keywords": ["ai", "agents", "claude", "codex", "cursor", "opencode", "gemini", "architecture", "skills", "orchestration", "task-graph", "planning"],
|
|
11
11
|
"repository": { "type": "git", "url": "git+https://github.com/akashmaurya99/archgen.git" },
|
|
12
|
+
"homepage": "https://github.com/akashmaurya99/archgen#readme",
|
|
13
|
+
"bugs": { "url": "https://github.com/akashmaurya99/archgen/issues" },
|
|
12
14
|
"//": "vendor/skills/archgen is synced from ../skills/archgen by scripts/sync-vendor.mjs (run automatically via prepublishOnly). The extension ships separately as a VS Code vsix.",
|
|
13
15
|
"scripts": {
|
|
14
16
|
"sync": "node scripts/sync-vendor.mjs",
|