forgedock 1.0.14 → 1.0.15
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 +102 -247
- package/docs/demo.gif +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,342 +4,199 @@
|
|
|
4
4
|
|
|
5
5
|
<h1>ForgeDock</h1>
|
|
6
6
|
|
|
7
|
-
<p><strong>
|
|
7
|
+
<p><strong>Give Claude Code a memory that survives every session.</strong></p>
|
|
8
8
|
|
|
9
|
-
<p>
|
|
9
|
+
<p>ForgeDock turns GitHub into a persistent knowledge graph for AI agents. Every pipeline stage writes structured annotations to issues and PRs — so the next agent always knows what happened, why the code looks this way, and what to do next.</p>
|
|
10
10
|
|
|
11
|
+
<a href="https://www.npmjs.com/package/forgedock"><img src="https://img.shields.io/npm/dm/forgedock?label=npm%20downloads&color=CB3837" alt="npm downloads/month" /></a>
|
|
12
|
+
<a href="https://www.npmjs.com/package/forgedock"><img src="https://img.shields.io/npm/v/forgedock?color=CB3837" alt="npm version" /></a>
|
|
13
|
+
<a href="https://nodejs.org/"><img src="https://img.shields.io/node/v/forgedock?color=339933" alt="node version" /></a>
|
|
14
|
+
<a href="https://docs.anthropic.com/en/docs/claude-code"><img src="https://img.shields.io/badge/Built%20for-Claude%20Code-7C3AED" alt="Claude Code" /></a>
|
|
11
15
|
<a href="LICENSE"><img src="https://img.shields.io/badge/License-AGPL--3.0-blue.svg" alt="License: AGPL-3.0" /></a>
|
|
12
|
-
<a href="https://github.com/RapierCraftStudios/ForgeDock/stargazers"><img src="https://img.shields.io/github/stars/RapierCraftStudios/ForgeDock?style=social" alt="GitHub Stars" /></a>
|
|
13
|
-
<a href="https://docs.anthropic.com/en/docs/claude-code"><img src="https://img.shields.io/badge/Built%20for-Claude%20Code-blueviolet" alt="Claude Code" /></a>
|
|
14
16
|
<a href="https://github.com/RapierCraftStudios/ForgeDock/pulls"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome" /></a>
|
|
15
|
-
<a href="https://github.com/sponsors/RapierCraftStudios"><img src="https://img.shields.io/badge/Sponsor
|
|
17
|
+
<a href="https://github.com/sponsors/RapierCraftStudios"><img src="https://img.shields.io/badge/Sponsor-%E2%9D%A4-ea4aaa.svg" alt="Sponsor" /></a>
|
|
16
18
|
|
|
17
19
|
<br /><br />
|
|
18
20
|
|
|
19
|
-
|
|
20
|
-
<img src="docs/demo.gif" alt="ForgeDock demo — zero to PR speedrun" width="900" />
|
|
21
|
+
<img src="docs/demo.gif" alt="ForgeDock demo — issue to merged PR in one command" width="900" />
|
|
21
22
|
|
|
22
|
-
<p><em>
|
|
23
|
+
<p><em>One command. Issue to merged PR — investigated, built, reviewed, and shipped.</em></p>
|
|
23
24
|
|
|
24
25
|
</div>
|
|
25
26
|
|
|
26
27
|
<br />
|
|
27
28
|
|
|
28
|
-
|
|
29
|
+
## Why ForgeDock
|
|
29
30
|
|
|
30
|
-
-
|
|
31
|
-
- Runs the full issue lifecycle autonomously: investigate → build → review → merge
|
|
32
|
-
- False positive rate dropped from 44% to under 10% through a self-improving review loop
|
|
31
|
+
AI coding agents forget everything between sessions. They re-investigate the same bugs, miss context from past PRs, and make mistakes that were already caught and fixed last week. There's no institutional memory.
|
|
33
32
|
|
|
34
|
-
|
|
35
|
-
npx forgedock # install in 10 seconds
|
|
36
|
-
```
|
|
33
|
+
ForgeDock fixes this by using **GitHub itself** as the memory layer. Every pipeline stage writes structured `FORGE:` annotations to issues and PRs. Every downstream agent reads them. When a new session starts — even after compaction — the agent queries GitHub and picks up exactly where the last one left off.
|
|
37
34
|
|
|
38
|
-
|
|
35
|
+
**The result:** agents that follow structured data instead of guessing.
|
|
39
36
|
|
|
40
37
|
---
|
|
41
38
|
|
|
42
|
-
##
|
|
39
|
+
## What You Get
|
|
43
40
|
|
|
44
|
-
|
|
|
41
|
+
| Capability | How it works |
|
|
45
42
|
|---|---|
|
|
46
|
-
|
|
|
47
|
-
|
|
|
48
|
-
|
|
|
49
|
-
|
|
|
50
|
-
|
|
|
51
|
-
|
|
52
|
-
---
|
|
53
|
-
|
|
54
|
-
```
|
|
55
|
-
You: /work-on #42
|
|
56
|
-
ForgeDock: Investigates → Architects → Builds → Quality gates → Reviews → Opens PR
|
|
57
|
-
You: *click merge*
|
|
58
|
-
```
|
|
43
|
+
| **Full-lifecycle automation** | `/work-on #42` — investigates the issue, architects a fix, builds it, runs quality gates, opens a PR, and reviews it. You click merge. |
|
|
44
|
+
| **Persistent agent memory** | Structured `FORGE:` annotations on GitHub issues/PRs survive compaction and session boundaries. Agents never start blind. |
|
|
45
|
+
| **9 specialist review agents** | Security, billing, database, concurrency, auth, frontend, API, performance, infrastructure — every PR gets domain-expert review. |
|
|
46
|
+
| **Cross-issue knowledge graph** | Agent fixing issue #43 reads the investigation from #42 and applies the known pattern — no re-investigation. |
|
|
47
|
+
| **Self-improving pipeline** | False positive rate dropped from 44% to under 10% through automated feedback loops. |
|
|
48
|
+
| **Parallel orchestration** | `/orchestrate` decomposes milestones into waves and runs `/work-on` on each in parallel. |
|
|
59
49
|
|
|
60
50
|
---
|
|
61
51
|
|
|
62
|
-
##
|
|
52
|
+
## Install
|
|
63
53
|
|
|
64
|
-
|
|
54
|
+
**Requirements:** [Node.js 18+](https://nodejs.org/) and [Claude Code](https://docs.anthropic.com/en/docs/claude-code)
|
|
65
55
|
|
|
66
|
-
|
|
56
|
+
```bash
|
|
57
|
+
# Install pipeline commands (symlinks into ~/.claude/commands/)
|
|
58
|
+
npx forgedock
|
|
67
59
|
|
|
68
|
-
|
|
60
|
+
# Generate config for your repo
|
|
61
|
+
npx forgedock init
|
|
62
|
+
```
|
|
69
63
|
|
|
70
|
-
|
|
64
|
+
That's it. Open Claude Code in your project and run `/work-on #42`.
|
|
71
65
|
|
|
72
|
-
|
|
66
|
+
<details>
|
|
67
|
+
<summary><strong>Other install methods & commands</strong></summary>
|
|
73
68
|
|
|
69
|
+
**Claude Code Plugin Marketplace** (v2.1.143+):
|
|
74
70
|
```
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
│ │
|
|
78
|
-
│ Issues: FORGE:INVESTIGATOR → FORGE:CONTRACT → FORGE:ARCHITECT │
|
|
79
|
-
│ PRs: FORGE:BUILDER → FORGE:REVIEW → FORGE:TRAJECTORY │
|
|
80
|
-
│ Links: git blame → commit → PR → issue → related issues │
|
|
81
|
-
│ │
|
|
82
|
-
│ Every agent reads this. Every agent writes to it. │
|
|
83
|
-
│ Nothing is lost between conversations. │
|
|
84
|
-
└─────────────────────────────────────────────────────────────────────┘
|
|
71
|
+
/plugin marketplace add RapierCraftStudios/ForgeDock
|
|
72
|
+
/plugin install forgedock@forgedock
|
|
85
73
|
```
|
|
86
74
|
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
## See It Working
|
|
94
|
-
|
|
95
|
-
> **Generate the demo GIF**: Install [VHS](https://github.com/charmbracelet/vhs) and run `vhs docs/demo.tape` — it outputs `docs/demo.gif` from the tape script in this repo.
|
|
96
|
-
|
|
97
|
-
Here's what a real pipeline run looks like. A user reports that an API endpoint is returning 500 errors — the pipeline takes it from there.
|
|
98
|
-
|
|
99
|
-
### Example 1: Bug fix with full context chain
|
|
100
|
-
|
|
101
|
-
A user opens issue #42: *"POST /api/payments returns 500 for free-tier users."*
|
|
102
|
-
|
|
75
|
+
**CLI commands:**
|
|
76
|
+
```bash
|
|
77
|
+
npx forgedock update # Pull latest commands
|
|
78
|
+
npx forgedock uninstall # Remove all ForgeDock commands from ~/.claude/commands/
|
|
79
|
+
npx forgedock help # Show all available commands
|
|
103
80
|
```
|
|
104
|
-
FORGE:INVESTIGATOR → Traced bug to commit e8f21a3 (PR #38). The payment validation
|
|
105
|
-
gate assumed all users have a billing profile — free-tier users don't.
|
|
106
|
-
Quantified impact: 12 affected users, 94 failed requests in the last 24h.
|
|
107
|
-
|
|
108
|
-
FORGE:CONTRACT → 2-file fix: add nil-check in payment validator,
|
|
109
|
-
add free-tier guard in the API router
|
|
110
81
|
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
Known pitfall: don't skip the audit log write on early returns.
|
|
115
|
-
|
|
116
|
-
FORGE:ARCHITECT → Ordered implementation plan with exact file/function/line table
|
|
117
|
-
|
|
118
|
-
FORGE:BUILDER → Branch fix/payment-validation-free-tier-42, 2 files changed
|
|
119
|
-
|
|
120
|
-
FORGE:REVIEW → 4 review agents, 0 findings, auto-merged to staging
|
|
82
|
+
**AI-powered setup** (inside Claude Code):
|
|
83
|
+
```
|
|
84
|
+
/forgedock-init # Guided config walkthrough — scans your repo, queries GitHub, auto-fills forge.yaml
|
|
121
85
|
```
|
|
122
86
|
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
### Example 2: Cross-issue knowledge graph
|
|
126
|
-
|
|
127
|
-
The fix for #42 only covered the `/payments` endpoint. But the same nil-check bug exists in `/invoices` and `/subscriptions`. The pipeline spawns issue #43.
|
|
128
|
-
|
|
129
|
-
The context phase reads the structured data from #42 and says: *"Billing profile nil-check was already fixed in payment_validator.py (#42) — same pattern must be applied consistently."* It doesn't re-investigate. It reads the knowledge graph and applies the known fix to the remaining endpoints. 7 minutes, start to merge.
|
|
130
|
-
|
|
131
|
-
### Example 3: Review agents catch bugs across service boundaries
|
|
132
|
-
|
|
133
|
-
A staging-to-main deploy PR gets reviewed by four specialized agents:
|
|
134
|
-
|
|
135
|
-
- **Concurrency agent** — verified idempotency keys through PostgreSQL advisory locks
|
|
136
|
-
- **Security agent** — flagged a `force_https` default change with broad blast radius
|
|
137
|
-
- **API agent** — verified route registration consistency across all endpoints
|
|
138
|
-
- **Billing Integrity agent** — found that the `/invoices` query still referenced an old column name that was renamed in a recent migration
|
|
139
|
-
|
|
140
|
-
That billing finding becomes a new issue — enters the same pipeline, gets investigated, built, reviewed, and merged. Bug caught before it hits production.
|
|
141
|
-
|
|
142
|
-
### Example 4: The pipeline catches its own false positives
|
|
143
|
-
|
|
144
|
-
A review agent flags "no input size cap on the system key path." The investigation phase traces the full call chain and finds the cap *already exists* in a downstream quality gate module. Closed as `workflow:invalid` with an explanation of why the review agent missed it (it only inspected the text-building logic, not the downstream gate). The trajectory recorded: *"Investigation revealed fix already present."*
|
|
145
|
-
|
|
146
|
-
The pipeline self-corrects. No wasted work. Full audit trail.
|
|
87
|
+
</details>
|
|
147
88
|
|
|
148
89
|
---
|
|
149
90
|
|
|
150
91
|
## How It Works
|
|
151
92
|
|
|
152
|
-
### The Pipeline
|
|
153
|
-
|
|
154
93
|
```
|
|
155
94
|
Issue → Investigate → Architect → Build → Quality Gate → Review → Merge
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
95
|
+
↓ ↓ ↓ ↓ ↓
|
|
96
|
+
writes to reads from reads from reads from writes to
|
|
97
|
+
GitHub GitHub GitHub GitHub GitHub
|
|
159
98
|
```
|
|
160
99
|
|
|
161
|
-
Each stage
|
|
162
|
-
|
|
163
|
-
| Stage | Reads | Writes |
|
|
164
|
-
| --- | --- | --- |
|
|
165
|
-
| **Investigate** | Issue body, `git blame`, related issues/PRs | `FORGE:INVESTIGATOR` — verdict, root cause, affected files, severity |
|
|
166
|
-
| **Context** | Historical findings from related PRs, known pitfalls | `FORGE:CONTEXT` — institutional memory for this module |
|
|
167
|
-
| **Architect** | Investigation + context findings | `FORGE:ARCHITECT` — ordered implementation plan, code paths, risks |
|
|
168
|
-
| **Build** | Investigation + context + architect plan | `FORGE:BUILDER` — branch, commits, files changed, checklist |
|
|
169
|
-
| **Quality Gate** | Builder output, 14+ domain-specific checks | `FORGE:QUALITY_GATE` — findings by domain (security, auth, DB, etc.) |
|
|
170
|
-
| **Review** | PR diff, builder contract, quality gate results | `FORGE:REVIEW` — per-agent findings with evidence and confidence |
|
|
171
|
-
| **Close** | All of the above | `FORGE:TRAJECTORY` — full audit trail of the entire run |
|
|
172
|
-
|
|
173
|
-
### GitHub as Database
|
|
100
|
+
Each stage writes a structured annotation (`<!-- FORGE:INVESTIGATOR -->`, `<!-- FORGE:CONTRACT -->`, etc.) to the GitHub issue or PR. Each downstream stage reads what came before. The `gh` CLI is the query interface.
|
|
174
101
|
|
|
175
|
-
|
|
102
|
+
| Stage | What it does |
|
|
103
|
+
|---|---|
|
|
104
|
+
| **Investigate** | Traces root cause via `git blame`, related issues/PRs. Writes verdict, affected files, severity. |
|
|
105
|
+
| **Context** | Surfaces historical bugs and known pitfalls from the same module. Institutional memory. |
|
|
106
|
+
| **Architect** | Produces ordered implementation plan with exact file/function/line targets. |
|
|
107
|
+
| **Build** | Writes code, creates branch, makes commits. Follows the architect's plan. |
|
|
108
|
+
| **Quality Gate** | 14+ domain-specific checks (security, auth, DB, concurrency, etc.) |
|
|
109
|
+
| **Review** | 9 specialist agents review the PR diff with confidence-rated findings. |
|
|
110
|
+
| **Close** | Records full audit trail as `FORGE:TRAJECTORY`. |
|
|
176
111
|
|
|
177
|
-
Labels track workflow state (`workflow:investigating`, `workflow:building`, `workflow:in-review`, `workflow:merged
|
|
112
|
+
Labels track workflow state (`workflow:investigating`, `workflow:building`, `workflow:in-review`, `workflow:merged`). The pipeline resumes from whatever state GitHub says it's in — restart-safe by design.
|
|
178
113
|
|
|
179
|
-
|
|
114
|
+
<details>
|
|
115
|
+
<summary><strong>Example: Full pipeline run</strong></summary>
|
|
180
116
|
|
|
181
|
-
|
|
117
|
+
Issue #42: *"POST /api/payments returns 500 for free-tier users."*
|
|
182
118
|
|
|
183
|
-
|
|
119
|
+
```
|
|
120
|
+
FORGE:INVESTIGATOR → Traced bug to commit e8f21a3 (PR #38). Payment validation
|
|
121
|
+
assumed all users have a billing profile — free-tier users don't.
|
|
184
122
|
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
| Database | Migrations, unbounded queries, NOT NULL without DEFAULT |
|
|
190
|
-
| Security | SQL injection, SSRF, XSS, hardcoded secrets |
|
|
191
|
-
| Concurrency | Idempotency, advisory locks, race conditions |
|
|
192
|
-
| Frontend | useEffect cleanup, error states, hook dependencies |
|
|
193
|
-
| API | Route registration, proxy paths, response contracts |
|
|
194
|
-
| Performance | N+1 queries, unbounded loops, missing indexes |
|
|
195
|
-
| Infrastructure | Dockerfile changes, volume permissions, CI/CD |
|
|
123
|
+
FORGE:CONTEXT → Surfaced 2 historical bugs in the same module:
|
|
124
|
+
#29 (nil-check on subscription lookup) and
|
|
125
|
+
#34 (billing profile race condition). Known pitfall:
|
|
126
|
+
don't skip audit log write on early returns.
|
|
196
127
|
|
|
197
|
-
|
|
128
|
+
FORGE:ARCHITECT → 2-file fix: nil-check in payment validator,
|
|
129
|
+
free-tier guard in the API router.
|
|
198
130
|
|
|
199
|
-
|
|
131
|
+
FORGE:BUILDER → Branch fix/payment-validation-free-tier-42, 2 files changed.
|
|
200
132
|
|
|
201
|
-
|
|
133
|
+
FORGE:REVIEW → 4 review agents, 0 findings, auto-merged to staging.
|
|
134
|
+
```
|
|
202
135
|
|
|
203
|
-
|
|
204
|
-
2. `/pipeline-health` correlates findings with prompt changes and build failures
|
|
205
|
-
3. The quality gate evolves — new domain checks get added from recurring patterns
|
|
206
|
-
4. False positive rate dropped from 44% to under 10% through this loop
|
|
136
|
+
The context phase caught the audit log pitfall from issue #34 — a completely different bug, months earlier, in the same module. That's institutional memory at work.
|
|
207
137
|
|
|
208
|
-
|
|
138
|
+
</details>
|
|
209
139
|
|
|
210
140
|
---
|
|
211
141
|
|
|
212
142
|
## Commands
|
|
213
143
|
|
|
214
144
|
| Command | What it does |
|
|
215
|
-
|
|
216
|
-
| **`/work-on`** | Full issue lifecycle: investigate → build →
|
|
217
|
-
| `/issue` |
|
|
218
|
-
| `/orchestrate` | Parallel execution
|
|
219
|
-
| `/review-pr` |
|
|
145
|
+
|---|---|
|
|
146
|
+
| **`/work-on #N`** | Full issue lifecycle: investigate → build → review → merge |
|
|
147
|
+
| `/issue` | Create a pipeline-ready GitHub issue |
|
|
148
|
+
| `/orchestrate` | Parallel execution across a milestone's issues |
|
|
149
|
+
| `/review-pr` | PR review with 9 domain-specialist agents |
|
|
220
150
|
| `/quality-gate` | Pre-commit checks across 14+ domains |
|
|
221
|
-
| `/milestone` |
|
|
151
|
+
| `/milestone` | Plan and ship milestones |
|
|
222
152
|
| `/deploy-info` | Staging vs main diff with risk assessment |
|
|
223
|
-
| `/review-pr-staging` |
|
|
153
|
+
| `/review-pr-staging` | Staging-to-main review gate |
|
|
224
154
|
| `/rollback` | Automated revert PR for production incidents |
|
|
225
155
|
| `/incident-response` | P0 coordination: hotfix, timeline, postmortem |
|
|
226
|
-
| `/
|
|
227
|
-
| `/
|
|
156
|
+
| `/autopilot` | Autonomous improvement: recon → triage → fix |
|
|
157
|
+
| `/pipeline-health` | Self-analysis and prompt tuning |
|
|
228
158
|
| `/security-audit` | 4-phase security posture audit |
|
|
229
|
-
| `/cleanup` | Sweeps stale issues, branches, worktrees |
|
|
230
|
-
| `/analytics` | Pull metrics from GSC, Clarity, Umami, Stripe, and more |
|
|
231
159
|
| `/qa-sweep` | Full platform QA via browser automation |
|
|
160
|
+
| `/analytics` | Pull metrics from GSC, Clarity, Umami, Stripe |
|
|
161
|
+
| `/cleanup` | Sweep stale issues, branches, worktrees |
|
|
232
162
|
|
|
233
163
|
---
|
|
234
164
|
|
|
235
|
-
##
|
|
236
|
-
|
|
237
|
-
ForgeDock today uses GitHub as its knowledge graph. It works — 20,000+ issues processed, real production codebases shipping autonomously. But GitHub wasn't designed for this. Issue comments are append-only text blobs. Labels are flat strings. Cross-references are implicit links, not queryable edges. Every annotation costs tokens to parse because it's wrapped in markdown meant for humans, not machines.
|
|
238
|
-
|
|
239
|
-
The end state is a **purpose-built knowledge graph** — a structured, token-efficient store designed from the ground up for AI agents to read and write. Not a GitHub overlay. Not a vector database bolted on the side. A first-class system where:
|
|
240
|
-
|
|
241
|
-
**In-house knowledge layer.** Replace GitHub comments with a native graph store where relationships are edges, not hyperlinks. An agent asking "what bugs has this module had in the last 30 days?" should be a graph query returning structured data — not parsing 50 issue comment bodies hoping to find `<!-- FORGE:INVESTIGATOR -->` tags. Annotations become nodes with typed relationships (caused-by, fixed-in, blocks, related-to) instead of flat text.
|
|
242
|
-
|
|
243
|
-
**Token-efficient by design.** Today, an agent reads a 3,000-character investigation comment to extract 5 fields. A purpose-built store returns those 5 fields directly — 50 tokens instead of 800. At pipeline scale (investigation + context + architect + builder + review), this compresses the context budget dramatically. Agents get more lookback within the same window.
|
|
244
|
-
|
|
245
|
-
**Self-improving feedback loops, closed tighter.** Right now, the improvement loop runs through `/pipeline-health` — a command a human invokes. In the end state, the pipeline continuously measures its own accuracy (false positive rates, investigation-to-build time, review-finding recurrence), identifies degrading patterns, and adjusts its own prompts, quality gate checks, and review focus areas without human intervention. Not "suggest improvements" — actually ship them, validate them, and roll back if metrics regress.
|
|
246
|
-
|
|
247
|
-
**Fully autonomous development cycles.** Today, `/autopilot` runs recon and creates issues, but a human gates every fix. The vision is a pipeline that can run continuously — detecting production issues, creating issues, investigating, building, reviewing, deploying to staging, validating, and promoting to production — with human oversight moving from "approve every action" to "set policy and review outcomes." The human becomes the architect, not the operator.
|
|
248
|
-
|
|
249
|
-
**Provider-agnostic agent runtime.** ForgeDock currently runs on Claude Code. The pipeline logic — the state machine, the annotation protocol, the review agent catalog — is model-agnostic. The goal is an agent runtime that can orchestrate any LLM (Claude, GPT, Gemini, open-source models) as specialized workers, choosing the right model for each task based on capability, cost, and latency.
|
|
250
|
-
|
|
251
|
-
The path from here to there is incremental. Each piece — the knowledge store, the tighter feedback loop, the autonomous deploy gate — can ship independently and compound with the others.
|
|
252
|
-
|
|
253
|
-
---
|
|
254
|
-
|
|
255
|
-
## Install
|
|
256
|
-
|
|
257
|
-
### Option A: npx (recommended)
|
|
258
|
-
|
|
259
|
-
**Step 1: Install commands**
|
|
260
|
-
|
|
261
|
-
```bash
|
|
262
|
-
npx forgedock
|
|
263
|
-
```
|
|
264
|
-
|
|
265
|
-
This symlinks all pipeline commands into your Claude Code environment (`~/.claude/commands/`).
|
|
266
|
-
|
|
267
|
-
> **Note:** If you run `npx forgedock` from inside the ForgeDock repository, it uses the local working-tree binary rather than the published package. Run from your own project directory, or use `npx forgedock@latest` to pin to the published release.
|
|
268
|
-
|
|
269
|
-
**Step 2: Generate config**
|
|
270
|
-
|
|
271
|
-
```bash
|
|
272
|
-
npx forgedock init # Auto-detects your repo, owner, and branches
|
|
273
|
-
```
|
|
274
|
-
|
|
275
|
-
Creates `forge.yaml` in your project root — the config file that makes ForgeDock work with your repo instead of a hardcoded one. It also injects a concise **ForgeDock usage block** into your project's `CLAUDE.md` so every Claude Code session in the repo automatically knows that ForgeDock drives development here and which commands to use.
|
|
276
|
-
|
|
277
|
-
To regenerate the block later (e.g. after a ForgeDock update):
|
|
165
|
+
## Uninstall
|
|
278
166
|
|
|
279
167
|
```bash
|
|
280
|
-
npx forgedock
|
|
281
|
-
```
|
|
282
|
-
|
|
283
|
-
**Step 3: AI-powered setup (optional)**
|
|
284
|
-
|
|
285
|
-
```
|
|
286
|
-
/forgedock-init # Inside Claude Code — guided full config walkthrough
|
|
168
|
+
npx forgedock uninstall
|
|
287
169
|
```
|
|
288
170
|
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
**Other commands:**
|
|
171
|
+
This removes all ForgeDock command symlinks from `~/.claude/commands/`. Your `forge.yaml` config and any `FORGE:` annotations on GitHub issues/PRs are left untouched.
|
|
292
172
|
|
|
173
|
+
To also remove the npm cache:
|
|
293
174
|
```bash
|
|
294
|
-
npx forgedock
|
|
295
|
-
|
|
296
|
-
npx forgedock help # Show all commands
|
|
175
|
+
npx forgedock uninstall
|
|
176
|
+
npm cache clean --force
|
|
297
177
|
```
|
|
298
178
|
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
If you're running Claude Code v2.1.143 or later, you can install ForgeDock directly through the plugin marketplace:
|
|
179
|
+
---
|
|
302
180
|
|
|
303
|
-
|
|
304
|
-
/plugin marketplace add RapierCraftStudios/ForgeDock
|
|
305
|
-
/plugin install forgedock@forgedock
|
|
306
|
-
```
|
|
181
|
+
## Documentation
|
|
307
182
|
|
|
308
|
-
|
|
183
|
+
- [Getting Started in 5 Minutes](docs/site/getting-started.md) — install, configure, first pipeline run
|
|
184
|
+
- [How the Knowledge Graph Works](docs/site/how-it-works.md) — FORGE annotations, context relay, compaction resilience
|
|
185
|
+
- [ForgeDock vs. Manual Workflows](docs/site/vs-manual-workflows.md) — structured pipelines vs. ad-hoc prompting
|
|
186
|
+
- [FORGE Annotation Protocol](docs/site/forge-annotation-protocol.md) — open standard spec for AI context passing
|
|
187
|
+
- [Command Reference](docs/site/command-reference.md) — all 25+ commands with usage and examples
|
|
309
188
|
|
|
310
189
|
---
|
|
311
190
|
|
|
312
191
|
## Show Your Support
|
|
313
192
|
|
|
314
|
-
|
|
193
|
+
Add a badge to your README:
|
|
315
194
|
|
|
316
195
|
```markdown
|
|
317
196
|
[](https://github.com/RapierCraftStudios/ForgeDock)
|
|
318
197
|
```
|
|
319
198
|
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
This creates a discovery channel — each badge is a backlink and a signal to other developers that the project is AI-pipeline driven.
|
|
323
|
-
|
|
324
|
-
### Star History
|
|
325
|
-
|
|
326
|
-
<a href="https://star-history.com/#RapierCraftStudios/ForgeDock&Date">
|
|
327
|
-
<picture>
|
|
328
|
-
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=RapierCraftStudios/ForgeDock&type=Date&theme=dark" />
|
|
329
|
-
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=RapierCraftStudios/ForgeDock&type=Date" />
|
|
330
|
-
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=RapierCraftStudios/ForgeDock&type=Date" />
|
|
331
|
-
</picture>
|
|
332
|
-
</a>
|
|
333
|
-
|
|
334
|
-
---
|
|
335
|
-
|
|
336
|
-
## Documentation
|
|
337
|
-
|
|
338
|
-
- [Getting Started in 5 Minutes](docs/site/getting-started.md) — install, configure, run your first pipeline
|
|
339
|
-
- [How ForgeDock's Knowledge Graph Works](docs/site/how-it-works.md) — FORGE annotations, the pipeline relay, compaction resilience
|
|
340
|
-
- [ForgeDock vs. Manual Claude Code Workflows](docs/site/vs-manual-workflows.md) — why structured pipelines beat ad-hoc prompting
|
|
341
|
-
- [The FORGE Annotation Protocol](docs/site/forge-annotation-protocol.md) — technical spec, open standard for AI context passing
|
|
342
|
-
- [Complete Command Reference](docs/site/command-reference.md) — all 25+ commands with usage and examples
|
|
199
|
+
[](https://github.com/RapierCraftStudios/ForgeDock)
|
|
343
200
|
|
|
344
201
|
---
|
|
345
202
|
|
|
@@ -349,12 +206,10 @@ PRs welcome. Every change goes through a PR, tested against 3+ scenarios, using
|
|
|
349
206
|
|
|
350
207
|
## License
|
|
351
208
|
|
|
352
|
-
[AGPL-3.0](LICENSE) — free to use, modify, and distribute. If you modify ForgeDock and offer it as a service
|
|
209
|
+
[AGPL-3.0](LICENSE) — free to use, modify, and distribute. If you modify ForgeDock and offer it as a service, you must open-source your modifications under the same license.
|
|
353
210
|
|
|
354
211
|
---
|
|
355
212
|
|
|
356
213
|
<div align="center">
|
|
357
|
-
|
|
358
214
|
<p>Built by <a href="https://github.com/RapierCraftStudios">RapierCraft Studios</a></p>
|
|
359
|
-
|
|
360
215
|
</div>
|
package/docs/demo.gif
ADDED
|
Binary file
|