@aslomon/effectum 0.1.0 → 0.1.1

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 ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Jason Salomon-Rinnert
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -12,14 +12,85 @@ _Effectum (Latin): the result, the accomplishment — that which has been brough
12
12
 
13
13
  <br>
14
14
 
15
- **An autonomous development system for Claude Code.**
16
- Turn your ideas into structured specifications, then let Claude Code implement them — with tests, security checks, and quality gates — while you sleep.
15
+ [Quick Start](#-quick-start) · [How It Works](#-how-it-works) · [The Workflow](#-the-workflow) · [PRD Workshop](#-the-prd-workshop) · [How is this different?](#-how-is-this-different) · [Limitations](#-limitations)
17
16
 
18
- <br>
17
+ </div>
19
18
 
20
- [Quick Start](#-quick-start) · [How It Works](#-how-it-works) · [The Workflow](#-the-workflow) · [PRD Workshop](#-the-prd-workshop) · [Documentation](#-documentation)
19
+ ---
21
20
 
22
- </div>
21
+ ## Why I built this
22
+
23
+ I'm a solo developer who builds everything with Claude Code. I tried BMAD, SpecKit, Taskmaster, GSD — they all taught me something. BMAD was too enterprise. SpecKit too rigid. GSD is brilliant at context engineering but doesn't help you write the spec in the first place.
24
+
25
+ So I built Effectum. It combines what I learned from all of them: structured specifications (like SpecKit), autonomous execution (like GSD's approach), and quality gates that actually enforce standards.
26
+
27
+ The result: describe what you want, write a proper spec with the PRD Workshop, then let Claude Code build it overnight with the Ralph Loop.
28
+
29
+ This isn't a new idea — it's the best combination of existing ideas I've found, packaged so it actually works.
30
+
31
+ ---
32
+
33
+ ## 🚀 Quick Start
34
+
35
+ ```bash
36
+ npx @aslomon/effectum
37
+ ```
38
+
39
+ The interactive installer asks two questions — scope (global or local) and runtime — then sets everything up.
40
+
41
+ ```bash
42
+ # Open Claude Code in your project
43
+ cd ~/my-project && claude
44
+
45
+ # Set up your project (substitutes placeholders in settings.json)
46
+ /setup .
47
+
48
+ # Write a specification
49
+ /prd:new
50
+
51
+ # Build it
52
+ /plan docs/prds/001-my-feature.md
53
+ ```
54
+
55
+ > [!TIP]
56
+ > That's it. Four steps from zero to autonomous development.
57
+
58
+ ### Install options
59
+
60
+ ```bash
61
+ npx @aslomon/effectum # Interactive (recommended)
62
+ npx @aslomon/effectum --global # Install to ~/.claude/ for all projects
63
+ npx @aslomon/effectum --local # Install to ./.claude/ for this project only
64
+ npx @aslomon/effectum --global --claude # Non-interactive, Claude Code runtime
65
+ ```
66
+
67
+ <details>
68
+ <summary><strong>Prefer the classic git approach?</strong></summary>
69
+
70
+ ```bash
71
+ git clone https://github.com/aslomon/effectum.git
72
+ cd effectum
73
+ claude
74
+ /setup ~/my-project
75
+ ```
76
+
77
+ </details>
78
+
79
+ ---
80
+
81
+ ## 📦 What's Included
82
+
83
+ One command. Everything you need for autonomous Claude Code development.
84
+
85
+ | What | Details |
86
+ |------|---------|
87
+ | **10 workflow commands** | `/plan`, `/tdd`, `/verify`, `/e2e`, `/code-review`, `/build-fix`, `/refactor-clean`, `/ralph-loop`, `/cancel-ralph`, `/checkpoint` |
88
+ | **PRD Workshop** | 8 knowledge files for guided specification writing |
89
+ | **4 MCP servers** | Context7, Playwright, Sequential Thinking, Filesystem |
90
+ | **Playwright setup** | Browser install + `playwright.config.ts` |
91
+ | **Stack presets** | Next.js + Supabase, Python + FastAPI, Swift/SwiftUI, Generic |
92
+ | **Quality gates** | 8 automated checks (build, types, lint, tests, security, etc.) |
93
+ | **Guardrails** | Rules that prevent known mistakes |
23
94
 
24
95
  ---
25
96
 
@@ -80,93 +151,6 @@ graph LR
80
151
 
81
152
  ---
82
153
 
83
- ## 🚀 Quick Start
84
-
85
- ```bash
86
- # 1. Install Effectum
87
- npx effectum
88
- ```
89
-
90
- The interactive installer asks two questions — scope (global or local) and runtime — then sets everything up.
91
-
92
- ```bash
93
- # 2. Open Claude Code in your project
94
- cd ~/my-project && claude
95
-
96
- # 3. Set up your project
97
- /setup .
98
-
99
- # 4. Write a specification
100
- /prd:new
101
-
102
- # 5. Build it
103
- /plan docs/prds/001-my-feature.md
104
- ```
105
-
106
- > [!TIP]
107
- > That's it. Five steps from zero to autonomous development.
108
-
109
- ### Install options
110
-
111
- ```bash
112
- npx effectum # Interactive (recommended)
113
- npx effectum --global # Install to ~/.claude/ for all projects
114
- npx effectum --local # Install to ./.claude/ for this project only
115
- npx effectum --global --claude # Non-interactive, Claude Code runtime
116
- ```
117
-
118
- <details>
119
- <summary><strong>Prefer the classic git approach?</strong></summary>
120
-
121
- ```bash
122
- git clone https://github.com/aslomon/effectum.git
123
- cd effectum
124
- claude
125
- /setup ~/my-project
126
- ```
127
-
128
- </details>
129
-
130
- ---
131
-
132
- ## 📦 What `/setup` Installs
133
-
134
- One command. Four questions. 14 files. Your project is ready.
135
-
136
- ```
137
- /setup ~/my-project
138
- ```
139
-
140
- Claude asks: **project name** → **tech stack** → **language** → **autonomy level**
141
-
142
- Then installs everything:
143
-
144
- <details>
145
- <summary><strong>📂 See all 14 installed files</strong></summary>
146
-
147
- <br>
148
-
149
- | File | What it does |
150
- | ------------------------------------ | ------------------------------------------------------------- |
151
- | `CLAUDE.md` | Your project's brain — rules, architecture, quality standards |
152
- | `AUTONOMOUS-WORKFLOW.md` | Complete reference guide (1,300+ lines) |
153
- | `.claude/commands/plan.md` | `/plan` — Analyze, create implementation plan, wait for OK |
154
- | `.claude/commands/tdd.md` | `/tdd` — Write tests first, then code |
155
- | `.claude/commands/verify.md` | `/verify` — Run all quality checks |
156
- | `.claude/commands/e2e.md` | `/e2e` — End-to-end browser tests |
157
- | `.claude/commands/code-review.md` | `/code-review` — Security + quality audit |
158
- | `.claude/commands/build-fix.md` | `/build-fix` — Fix errors one at a time |
159
- | `.claude/commands/refactor-clean.md` | `/refactor-clean` — Remove dead code |
160
- | `.claude/commands/ralph-loop.md` | `/ralph-loop` — Fully autonomous overnight mode |
161
- | `.claude/commands/cancel-ralph.md` | `/cancel-ralph` — Stop the loop |
162
- | `.claude/commands/checkpoint.md` | `/checkpoint` — Git restore point |
163
- | `.claude/settings.json` | Auto-formatting, file protection, safety hooks |
164
- | `.claude/guardrails.md` | Rules that prevent known mistakes |
165
-
166
- </details>
167
-
168
- ---
169
-
170
154
  ## 🔧 The Workflow
171
155
 
172
156
  ### `/plan` — Think before building
@@ -291,37 +275,6 @@ The better the spec, the better the code.
291
275
  └─────────────────────────────────────────┘
292
276
  ```
293
277
 
294
- ### Network Map
295
-
296
- For complex projects, Effectum generates a **visual network map** showing how every feature, module, and data entity connects:
297
-
298
- ```mermaid
299
- graph TB
300
- subgraph "PRD-001: Auth"
301
- AUTH[Authentication]:::done
302
- PROFILES[User Profiles]:::done
303
- end
304
- subgraph "PRD-002: Core"
305
- PROJECTS[Projects]:::inProgress
306
- TASKS[Tasks]:::inProgress
307
- KANBAN(Kanban Board):::planned
308
- end
309
- subgraph "PRD-003: AI"
310
- SUMMARY[AI Summary]:::planned
311
- end
312
-
313
- AUTH --> PROJECTS
314
- PROJECTS --> TASKS
315
- TASKS --> KANBAN
316
- TASKS --> SUMMARY
317
-
318
- classDef done fill:#dcfce7,stroke:#22c55e,stroke-width:2px,color:#166534
319
- classDef inProgress fill:#dbeafe,stroke:#3b82f6,stroke-width:2px,color:#1e40af
320
- classDef planned fill:#f3f4f6,stroke:#9ca3af,stroke-width:2px,color:#374151
321
- ```
322
-
323
- <sup>🟢 Done 🔵 In Progress ⚪ Planned</sup>
324
-
325
278
  ### Workshop Commands
326
279
 
327
280
  | Command | What it does |
@@ -341,64 +294,16 @@ graph TB
341
294
 
342
295
  ---
343
296
 
344
- ## 🌳 Branching & Worktrees
345
-
346
- Each PRD project in the workshop gets its own **git branch** — so you can work on multiple projects in parallel without interference.
347
-
348
- ```mermaid
349
- gitGraph
350
- commit id: "initial"
351
- branch project/taskflow
352
- checkout project/taskflow
353
- commit id: "vision.md"
354
- commit id: "PRD-001 auth"
355
- commit id: "PRD-002 tasks"
356
- commit id: "network-map"
357
- checkout main
358
- branch project/kniffelig
359
- commit id: "vision"
360
- commit id: "PRD-001 redesign"
361
- checkout main
362
- merge project/taskflow id: "taskflow ready"
363
- ```
364
-
365
- ### How It Works
366
-
367
- **When you start a new project** (`/prd:new` or `/workshop:init`):
297
+ ## 🆚 How is this different?
368
298
 
369
- - A new branch `project/{slug}` is created
370
- - All PRD work happens on this branch
371
- - Your other projects remain untouched on their own branches
299
+ | Tool | What it does | What Effectum adds |
300
+ |------|-------------|-------------------|
301
+ | **GSD** | Context engineering, prevents context rot | PRD Workshop (helps you write the spec), Ralph Loop (autonomous overnight) |
302
+ | **BMAD** | Full enterprise methodology | Same ideas, 90% less ceremony |
303
+ | **SpecKit** | Living specifications | + Autonomous execution + Quality gates |
304
+ | **Taskmaster** | Task breakdown from PRDs | + TDD workflow + Code review + E2E testing |
372
305
 
373
- **When a project is done** (`/workshop:archive`):
374
-
375
- - The branch is merged into `main`
376
- - All specs are preserved in the history
377
-
378
- **Working on multiple projects simultaneously** with worktrees:
379
-
380
- ```bash
381
- # Main repo — working on TaskFlow
382
- cd ~/effectum
383
- # (on branch project/taskflow)
384
-
385
- # Open a second project in a worktree
386
- git worktree add ../effectum-kniffelig project/kniffelig
387
-
388
- # Now you have two separate directories, each on its own branch:
389
- # ~/effectum/ → project/taskflow
390
- # ~/effectum-kniffelig/ → project/kniffelig
391
- ```
392
-
393
- > [!TIP]
394
- > **Worktrees** let you open Claude Code in each project simultaneously — two terminal windows, two branches, zero conflicts.
395
-
396
- ### Branch Overview
397
-
398
- | Branch | Purpose | Lifetime |
399
- | ---------------- | --------------------------------------- | -------------- |
400
- | `main` | Stable state, knowledge base, templates | Permanent |
401
- | `project/{slug}` | Active PRD work for one project | Until archived |
306
+ The short version: Effectum doesn't invent new concepts. It combines what already works, removes what doesn't, and packages it so it actually runs.
402
307
 
403
308
  ---
404
309
 
@@ -471,51 +376,15 @@ Choose during `/setup`. Change anytime in `.claude/settings.json`.
471
376
 
472
377
  ---
473
378
 
474
- ## 🏗️ The Big Picture
475
-
476
- ```
477
- ┌──────────────────────────────────────────────────┐
478
- │ EFFECTUM REPO │
479
- │ (clone once, use for all your projects) │
480
- │ │
481
- │ /setup ~/project-a → Install workflow │
482
- │ /setup ~/project-b → Install workflow │
483
- │ /setup ~/project-c → Install workflow │
484
- │ │
485
- │ /prd:new → Write specifications │
486
- │ /prd:handoff → Send to project │
487
- └──────────┬───────────────────────────────────────┘
488
-
489
- │ installs: CLAUDE.md, 10 commands,
490
- │ hooks, guardrails, quality gates
491
-
492
- ┌─────┼─────────────┬──────────────┐
493
- ▼ ▼ ▼ ▼
494
- ┌─────────┐ ┌─────────┐ ┌─────────┐
495
- │Project A│ │Project B│ │Project C│
496
- │ │ │ │ │ │
497
- │ /plan │ │ /plan │ │ /plan │
498
- │ /tdd │ │ /tdd │ │ /tdd │
499
- │ /verify │ │ /verify │ │ /verify │
500
- │ /ralph │ │ /ralph │ │ /ralph │
501
- │ -loop │ │ -loop │ │ -loop │
502
- │ │ │ │ │ │
503
- │ ✅ Code │ │ ✅ Code │ │ ✅ Code │
504
- └─────────┘ └─────────┘ └─────────┘
505
- ```
506
-
507
- ---
379
+ ## ⚠️ Limitations
508
380
 
509
- ## 📊 Before & After
381
+ Effectum is useful, but it's honest about what it can't do yet:
510
382
 
511
- | | Without Effectum | With Effectum |
512
- | -------------- | ---------------------------------- | -------------------------------------------------- |
513
- | 💡 Starting | _"Build a login"_ Claude guesses | Detailed spec Claude knows exactly what to build |
514
- | 🧪 Testing | Maybe write tests after | Tests written **first**, always |
515
- | Quality | Hope for the best | **8 automated gates** must pass |
516
- | 🔒 Security | Manual review (or forget) | Automatic **OWASP audit** |
517
- | 🌙 Overnight | Not possible | Ralph Loop **builds while you sleep** |
518
- | 🔄 Consistency | Depends on the prompt | **Same workflow, same quality**, every time |
383
+ - **Only works with Claude Code** — workflow commands are Claude Code specific. Other runtimes (Codex, Gemini CLI) are on the roadmap.
384
+ - **PRD Workshop requires Claude Code slash commands** — you can't use it from the web interface or API directly.
385
+ - **Ralph Loop effectiveness depends on PRD quality** garbage in, garbage out. A vague spec produces vague code, even autonomously.
386
+ - **MCP servers need npm/Node.js** if you're in a restricted environment without npm access, MCP setup will fail.
387
+ - **No test suite yet** — ironic for a TDD tool. It's on the list.
519
388
 
520
389
  ---
521
390
 
@@ -571,7 +440,7 @@ No. Use `/plan` directly with a description for small things. Specifications shi
571
440
  <details>
572
441
  <summary><strong>Does this work with other AI coding tools?</strong></summary>
573
442
 
574
- Effectum is built for Claude Code. The specifications it produces are useful for any AI tool, but the workflow commands (`/plan`, `/tdd`, etc.) are Claude Code specific.
443
+ Effectum is built for Claude Code. The specifications it produces are useful for any AI tool, but the workflow commands (`/plan`, `/tdd`, etc.) are Claude Code specific. See [Limitations](#️-limitations).
575
444
 
576
445
  </details>
577
446
 
@@ -597,9 +466,9 @@ Yes. File protection blocks writes to `.env` and secrets. Destructive command pr
597
466
  </details>
598
467
 
599
468
  <details>
600
- <summary><strong>Can I work on multiple PRD projects simultaneously?</strong></summary>
469
+ <summary><strong>What does /setup actually do?</strong></summary>
601
470
 
602
- Yes. Each project gets its own git branch. Use `git worktree` to open multiple projects in separate directories each with its own Claude Code session. See [Branching & Worktrees](#-branching--worktrees).
471
+ `/setup` configures your project by substituting placeholders in `settings.json` and `CLAUDE.md` with your actual project name, tech stack, language, and autonomy level. Run it once per project after installing Effectum.
603
472
 
604
473
  </details>
605
474
 
@@ -620,7 +489,7 @@ The most impactful areas:
620
489
 
621
490
  ## License
622
491
 
623
- MIT
492
+ MIT © 2026 [Jason Salomon-Rinnert](https://github.com/aslomon)
624
493
 
625
494
  <br>
626
495
 
package/bin/install.js CHANGED
@@ -633,11 +633,13 @@ ${bold('Options:')}
633
633
  console.log(' ' + bold('Next steps:'));
634
634
  console.log(` ${cyan('1.')} Open Claude Code in any project`);
635
635
  console.log(` ${cyan('2.')} Run ${bold('/setup ~/your-project')} to configure it`);
636
+ console.log(` ${dim('↳ /setup substitutes placeholders in settings.json for your project')}`);
636
637
  console.log(` ${cyan('3.')} Write a spec with ${bold('/prd:new')}`);
637
638
  } else {
638
639
  console.log(' ' + bold('Next steps:'));
639
640
  console.log(` ${cyan('1.')} Open Claude Code here: ${dim('claude')}`);
640
641
  console.log(` ${cyan('2.')} Run ${bold('/setup .')} to configure this project`);
642
+ console.log(` ${dim('↳ /setup substitutes placeholders in settings.json for your project')}`);
641
643
  console.log(` ${cyan('3.')} Write a spec with ${bold('/prd:new')}`);
642
644
  }
643
645
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aslomon/effectum",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Autonomous development system for Claude Code — describe what you want, get production-ready code",
5
5
  "bin": {
6
6
  "effectum": "bin/install.js"
@@ -70,7 +70,7 @@
70
70
  | `/refactor-clean` | Cleanup | Remove dead code |
71
71
  | `/checkpoint` | Safety | Create a restore point |
72
72
  | `/ralph-loop` | Full Auto | Iterative autonomous implementation |
73
- | `/orchestrate` | Teams | Parallel multi-agent implementation |
73
+
74
74
 
75
75
  ## Context7 — Always Use for Research
76
76