learnship 2.1.1 → 2.2.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/.claude-plugin/plugin.json +1 -1
- package/.cursor-plugin/plugin.json +1 -1
- package/README.md +172 -155
- package/SKILL.md +23 -2
- package/bin/install.js +305 -3
- package/commands/learnship/diagnose-issues.md +1 -0
- package/commands/learnship/discuss-phase.md +1 -0
- package/commands/learnship/ideate.md +1 -0
- package/commands/learnship/list-phase-assumptions.md +1 -0
- package/commands/learnship/quick.md +1 -0
- package/commands/learnship/research-phase.md +1 -0
- package/commands/learnship/secure-phase.md +1 -0
- package/commands/learnship/validate-phase.md +2 -0
- package/commands/learnship/verify-work.md +1 -0
- package/cursor-rules/learnship.mdc +14 -4
- package/gemini-extension.json +1 -1
- package/hooks/learnship-context-monitor.js +120 -0
- package/hooks/learnship-prompt-guard.js +75 -0
- package/hooks/learnship-session-state.js +136 -0
- package/hooks/learnship-statusline.js +179 -0
- package/learnship/contexts/dev.md +21 -0
- package/learnship/contexts/research.md +22 -0
- package/learnship/contexts/review.md +22 -0
- package/learnship/templates/research-project/ARCHITECTURE.md +140 -0
- package/learnship/templates/research-project/FEATURES.md +130 -0
- package/learnship/templates/research-project/PITFALLS.md +102 -0
- package/learnship/templates/research-project/STACK.md +105 -0
- package/learnship/templates/research-project/SUMMARY.md +111 -0
- package/learnship/workflows/challenge.md +16 -4
- package/learnship/workflows/debug.md +30 -6
- package/learnship/workflows/diagnose-issues.md +14 -1
- package/learnship/workflows/discuss-milestone.md +15 -1
- package/learnship/workflows/discuss-phase.md +83 -10
- package/learnship/workflows/ideate.md +25 -5
- package/learnship/workflows/list-phase-assumptions.md +12 -5
- package/learnship/workflows/new-milestone.md +12 -6
- package/learnship/workflows/new-project.md +229 -85
- package/learnship/workflows/quick.md +18 -4
- package/learnship/workflows/research-phase.md +43 -8
- package/learnship/workflows/secure-phase.md +57 -15
- package/learnship/workflows/settings.md +142 -142
- package/learnship/workflows/validate-phase.md +39 -12
- package/learnship/workflows/verify-work.md +27 -0
- package/package.json +1 -1
- package/templates/config.json +1 -0
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "learnship",
|
|
3
3
|
"description": "Agentic engineering done right — 57 structured workflows, persistent memory across sessions, integrated learning partner, and impeccable UI design system. Works with Claude Code, Windsurf, Cursor, Gemini CLI, OpenCode, and Codex.",
|
|
4
|
-
"version": "2.
|
|
4
|
+
"version": "2.2.0",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Favio Vazquez",
|
|
7
7
|
"email": "favio.vazquezp@gmail.com"
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "learnship",
|
|
3
3
|
"displayName": "learnship",
|
|
4
4
|
"description": "Agentic engineering done right — 57 structured workflows, persistent memory across sessions, integrated learning partner, and impeccable UI design system.",
|
|
5
|
-
"version": "2.
|
|
5
|
+
"version": "2.2.0",
|
|
6
6
|
"logo": "assets/logo.png",
|
|
7
7
|
"author": {
|
|
8
8
|
"name": "Favio Vazquez",
|
package/README.md
CHANGED
|
@@ -14,178 +14,91 @@
|
|
|
14
14
|
</p>
|
|
15
15
|
|
|
16
16
|
<p align="center">
|
|
17
|
-
<strong>Agentic engineering done right.</strong><br>
|
|
18
|
-
<
|
|
19
|
-
|
|
20
|
-
|
|
17
|
+
<strong>Agentic engineering done right. Learn as you build. Build with intent.</strong><br>
|
|
18
|
+
<strong>A context engineering and spec-driven development system for Claude Code, Windsurf, Cursor, OpenCode, Gemini CLI, and Codex CLI.</strong>
|
|
19
|
+
</p>
|
|
20
|
+
|
|
21
|
+
<p align="center">
|
|
22
|
+
<a href="#-install">Install</a> ·
|
|
23
|
+
<a href="#-the-5-commands">5 Commands</a> ·
|
|
21
24
|
<a href="#-the-phase-loop">Phase Loop</a> ·
|
|
22
|
-
<a href="#-
|
|
23
|
-
<a href="#-
|
|
24
|
-
<a href="
|
|
25
|
+
<a href="#-how-it-works">How It Works</a> ·
|
|
26
|
+
<a href="#-workflow-reference-advanced">All Workflows</a> ·
|
|
27
|
+
<a href="https://faviovazquez.github.io/learnship/">Full Docs</a> ·
|
|
25
28
|
<a href="CHANGELOG.md">Changelog</a>
|
|
26
29
|
</p>
|
|
27
30
|
|
|
28
31
|
---
|
|
29
32
|
|
|
30
|
-
##
|
|
31
|
-
|
|
32
|
-
learnship is an **agent harness** for anyone who wants to build, learn, and ship real products using AI agents. It's the scaffolding that makes your AI coding agent actually reliable across real projects.
|
|
33
|
-
|
|
34
|
-
Every serious AI coding tool (Claude Code, Cursor, Manus, Devin) converges on the same architecture: a simple execution loop wraps the model, and the **harness** decides what information reaches the model, when, and how. The model is interchangeable. The harness is the product.
|
|
35
|
-
|
|
36
|
-
learnship gives you that harness as a portable, open-source layer that runs inside Windsurf, Claude Code, Cursor, OpenCode, Gemini CLI, or Codex CLI and adds three things your agent doesn't have by default:
|
|
37
|
-
|
|
38
|
-
- **Persistent memory.** `/new-project` generates an `AGENTS.md` at your project root. Windsurf, Claude Code, and Cursor load it automatically every session; on other platforms the workflows reference it explicitly. No more repeating yourself.
|
|
39
|
-
- **Structured process.** A repeatable phase loop (Discuss → Plan → Execute → Verify → Review → Ship → Compound) with spec-driven plans, wave-ordered execution, and UAT-driven verification. The harness controls what context reaches the agent at each step.
|
|
40
|
-
- **Knowledge compounding (v2.0).** `/compound` captures solved problems as searchable documentation. `/review` runs multi-persona code review. `/challenge` stress-tests scope. `/ship` runs the full delivery pipeline. `/ideate` generates codebase-grounded ideas. `/guard` adds safety mode. `/sync-docs` detects stale documentation.
|
|
41
|
-
- **Security, recovery, and session intelligence (v2.1).** `/secure-phase` runs per-phase STRIDE threat verification. `/forensics` investigates failed workflows. `/undo` safely reverts commits. `/note` captures ideas with zero friction. `/session-report` generates stakeholder summaries. `/docs-update` generates and verifies project documentation. `/extract-learnings` captures meta-knowledge from completed phases.
|
|
42
|
-
- **Built-in learning.** Neuroscience-backed checkpoints at every phase transition so you understand what you shipped, not just that you shipped it.
|
|
43
|
-
|
|
44
|
-
---
|
|
45
|
-
|
|
46
|
-
## What problem does it solve?
|
|
47
|
-
|
|
48
|
-
If you've used AI coding assistants for more than a few sessions, you've hit this wall:
|
|
49
|
-
|
|
50
|
-
> The agent forgets everything. Each session starts from scratch. Decisions get repeated. Code quality drifts. You ship fast but understand less. The more you rely on the AI, the less you own the outcome.
|
|
51
|
-
|
|
52
|
-
This is a **harness problem**, not a model problem. Research shows the same model on the same benchmark scores 42% with one scaffold and 78% with another. Cursor's lazy context loading cuts token usage by 47%. Vercel deleted 80% of their agent's tools and watched it go from failing tasks to completing them. Same model. The only variable is the harness.
|
|
53
|
-
|
|
54
|
-
learnship solves this with **progressive disclosure**, the pattern that separates working agents from impressive demos. Context is revealed incrementally, not dumped upfront. The right files, decisions, and phase context reach the agent exactly when needed, nothing more.
|
|
55
|
-
|
|
56
|
-
| Without learnship | With learnship |
|
|
57
|
-
|-------------------|----------------|
|
|
58
|
-
| Context resets every session | `AGENTS.md` loaded automatically every conversation |
|
|
59
|
-
| Ad-hoc prompts, unpredictable results | Spec-driven plans, verifiable deliverables |
|
|
60
|
-
| Architectural decisions get forgotten | `DECISIONS.md` tracked and honored by the agent |
|
|
61
|
-
| Everything dumped into context at once | Phase-scoped context: only what this step needs |
|
|
62
|
-
| You ship code you don't fully understand | Learning checkpoints build real understanding at every step |
|
|
63
|
-
| UI looks generic, AI-generated | `impeccable` design system prevents AI aesthetic slop |
|
|
64
|
-
|
|
65
|
-
---
|
|
66
|
-
|
|
67
|
-
## Who is it for?
|
|
68
|
-
|
|
69
|
-
learnship is built for **anyone who wants to build and ship real products with AI agents**, not just developers. If you're a founder, designer, researcher, or maker who uses AI tools to build things, this is for you.
|
|
70
|
-
|
|
71
|
-
It's the right tool if:
|
|
72
|
-
|
|
73
|
-
- You're **building a real project** (not just experimenting) and want the AI to stay aligned across sessions
|
|
74
|
-
- You're **learning while building** and want to actually understand what gets shipped
|
|
75
|
-
- You care about **code quality and UI quality** beyond "it works"
|
|
76
|
-
- You want **parallel agent execution** on Claude Code, OpenCode, or Gemini CLI to ship phases faster
|
|
77
|
-
- You've felt the frustration of **context loss**: repeating yourself every session while the agent forgets past decisions
|
|
78
|
-
|
|
79
|
-
It's probably overkill if you just need one-off scripts or quick fixes. Use `/quick` for that.
|
|
80
|
-
|
|
81
|
-
---
|
|
82
|
-
|
|
83
|
-
## ⚡ Get Started in 30 Seconds
|
|
84
|
-
|
|
85
|
-
### 1. Install
|
|
33
|
+
## ⚡ Install
|
|
86
34
|
|
|
87
35
|

|
|
88
36
|
|
|
89
|
-
**Requirements:** Node.js ≥ 18, Git. [Details →](https://faviovazquez.github.io/learnship/getting-started/installation/#requirements)
|
|
90
|
-
|
|
91
|
-
**Via npm (all platforms — recommended):**
|
|
92
|
-
|
|
93
37
|
```bash
|
|
94
38
|
npx learnship
|
|
95
39
|
```
|
|
96
40
|
|
|
97
|
-
|
|
41
|
+
**Works on Mac, Windows, and Linux.** Requires Node.js ≥ 18 and Git. The installer auto-detects your platform.
|
|
98
42
|
|
|
99
43
|
```bash
|
|
100
44
|
npx learnship --global # all projects
|
|
101
45
|
npx learnship --local # this project only
|
|
46
|
+
npx learnship --all --global # all 6 platforms at once
|
|
102
47
|
```
|
|
103
48
|
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
```bash
|
|
107
|
-
# Claude Code — community marketplace
|
|
108
|
-
/plugin marketplace add FavioVazquez/learnship-marketplace
|
|
109
|
-
/plugin install learnship@learnship-marketplace
|
|
110
|
-
|
|
111
|
-
# Cursor — after marketplace approval
|
|
112
|
-
/add-plugin learnship
|
|
113
|
-
|
|
114
|
-
# Gemini CLI — native extension
|
|
115
|
-
gemini extensions install https://github.com/FavioVazquez/learnship
|
|
116
|
-
```
|
|
117
|
-
|
|
118
|
-
Or specify your platform explicitly. See [Platform Support](#-platform-support) below.
|
|
119
|
-
|
|
120
|
-
### Why `npx learnship`?
|
|
121
|
-
|
|
122
|
-
learnship is published to npm — `npx learnship` pulls the latest release directly. No `github:` prefix, no clone needed, no version pinning. The same `bin/install.js` runs regardless of whether you install via npm, marketplace, or native extension.
|
|
123
|
-
|
|
124
|
-
### 2. Start your AI agent and type
|
|
49
|
+
Then open your AI agent and type:
|
|
125
50
|
|
|
126
51
|
```
|
|
127
52
|
/ls
|
|
128
53
|
```
|
|
129
54
|
|
|
130
|
-
|
|
55
|
+
That's it. `/ls` tells you where you are, what to do next, and offers to run it.
|
|
131
56
|
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
## 📚 Documentation
|
|
135
|
-
|
|
136
|
-
The full documentation site is at **[faviovazquez.github.io/learnship](https://faviovazquez.github.io/learnship/)**, built with MkDocs Material and deployed automatically on every release.
|
|
137
|
-
|
|
138
|
-
What's covered:
|
|
139
|
-
|
|
140
|
-
- **[Getting Started](https://faviovazquez.github.io/learnship/getting-started/installation/)**: install commands, first project walkthrough, the 5 commands you need to know
|
|
141
|
-
- **[Platform Guide](https://faviovazquez.github.io/learnship/platform-guide/windsurf/)**: dedicated pages for Windsurf, Claude Code, Cursor, OpenCode, Gemini CLI, and Codex CLI
|
|
142
|
-
- **[Core Concepts](https://faviovazquez.github.io/learnship/core-concepts/phase-loop/)**: phase loop, context engineering, planning artifacts, agentic vs vibe coding
|
|
143
|
-
- **[Skills](https://faviovazquez.github.io/learnship/skills/agentic-learning/)**: all 11 `@agentic-learning` actions and all 21 `impeccable` design commands
|
|
144
|
-
- **[Workflow Reference](https://faviovazquez.github.io/learnship/workflow-reference/core/)**: all 57 workflows documented with when and why to use each
|
|
145
|
-
- **[Configuration](https://faviovazquez.github.io/learnship/configuration/)**: full `.planning/config.json` schema, speed presets, parallelization
|
|
146
|
-
|
|
147
|
-
---
|
|
148
|
-
|
|
149
|
-
## 🌐 Platform Support
|
|
150
|
-
|
|
151
|
-
learnship works on **6 platforms**. Pick your tool:
|
|
57
|
+
<details>
|
|
58
|
+
<summary><strong>Platform-specific install + marketplace options</strong></summary>
|
|
152
59
|
|
|
153
60
|
| Platform | Install command | Invoke commands as |
|
|
154
61
|
|----------|----------------|-------------------|
|
|
155
62
|
| **Windsurf** | `npx learnship --windsurf --global` | `/ls`, `/new-project` |
|
|
156
63
|
| **Claude Code** | `npx learnship --claude --global` | `/learnship:ls`, `/learnship:new-project` |
|
|
157
|
-
| **Cursor** | `/add-plugin learnship` *(
|
|
64
|
+
| **Cursor** | `/add-plugin learnship` *(marketplace)* | `@learnship` rules load automatically |
|
|
158
65
|
| **OpenCode** | `npx learnship --opencode --global` | `/learnship-ls`, `/learnship-new-project` |
|
|
159
66
|
| **Gemini CLI** | `npx learnship --gemini --global` | `/learnship:ls`, `/learnship:new-project` |
|
|
160
67
|
| **Codex CLI** | `npx learnship --codex --global` | `$learnship-ls`, `$learnship-new-project` |
|
|
161
68
|
|
|
69
|
+
**Via marketplace (no terminal required):**
|
|
70
|
+
|
|
162
71
|
```bash
|
|
163
|
-
#
|
|
164
|
-
|
|
72
|
+
# Claude Code — community marketplace
|
|
73
|
+
/plugin marketplace add FavioVazquez/learnship-marketplace
|
|
74
|
+
/plugin install learnship@learnship-marketplace
|
|
75
|
+
|
|
76
|
+
# Cursor — after marketplace approval
|
|
77
|
+
/add-plugin learnship
|
|
78
|
+
|
|
79
|
+
# Gemini CLI — native extension
|
|
80
|
+
gemini extensions install https://github.com/FavioVazquez/learnship
|
|
165
81
|
```
|
|
166
82
|
|
|
167
|
-
|
|
83
|
+
**Custom install directory:**
|
|
168
84
|
|
|
169
|
-
|
|
85
|
+
```bash
|
|
86
|
+
npx learnship --claude --global --target /path/to/custom/dir
|
|
87
|
+
```
|
|
170
88
|
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
| Real parallel subagents | — | ✓ | ✓ | ✓ | ✓ |
|
|
175
|
-
| Parallel wave execution | — | ✓ opt-in | ✓ opt-in | ✓ | ✓ opt-in |
|
|
176
|
-
| Specialist agent pool | — | ✓ | ✓ | ✓ | ✓ |
|
|
177
|
-
| Skills (native `@invoke`) | ✓ | — | — | — | — |
|
|
178
|
-
| Skills (context files) | ✓ | ✓ | ✓ | ✓ | ✓ |
|
|
89
|
+
`--target` overrides the default platform directory. Works with install and uninstall on all 6 platforms.
|
|
90
|
+
|
|
91
|
+
learnship is published to npm — `npx learnship` pulls the latest release directly. No `github:` prefix, no clone needed. The same `bin/install.js` runs regardless of install method.
|
|
179
92
|
|
|
180
|
-
|
|
93
|
+
</details>
|
|
181
94
|
|
|
182
95
|
---
|
|
183
96
|
|
|
184
|
-
## 🗺️ The 5 Commands
|
|
97
|
+
## 🗺️ The 5 Commands
|
|
185
98
|
|
|
186
99
|

|
|
187
100
|
|
|
188
|
-
learnship has 57 workflows. You
|
|
101
|
+
learnship has 57 workflows. You need five. Everything else surfaces naturally from `/ls`.
|
|
189
102
|
|
|
190
103
|
| Command | What it does | When to use |
|
|
191
104
|
|---------|-------------|-------------|
|
|
@@ -195,7 +108,7 @@ learnship has 57 workflows. You don't need to know them all. Start with these fi
|
|
|
195
108
|
| `/quick "..."` | One-off task with atomic commits, no planning ceremony | Small fixes, experiments |
|
|
196
109
|
| `/help` | All 57 workflows organized by category | Discovering capabilities |
|
|
197
110
|
|
|
198
|
-
> **Tip:** `/ls` works for both new and returning users.
|
|
111
|
+
> **Tip:** `/ls` works for both new and returning users. No project? It explains learnship and offers `/new-project`. Returning? It shows your progress and suggests exactly what to do next.
|
|
199
112
|
|
|
200
113
|
---
|
|
201
114
|
|
|
@@ -203,7 +116,7 @@ learnship has 57 workflows. You don't need to know them all. Start with these fi
|
|
|
203
116
|
|
|
204
117
|

|
|
205
118
|
|
|
206
|
-
|
|
119
|
+
Every feature ships through a 7-step loop:
|
|
207
120
|
|
|
208
121
|
```mermaid
|
|
209
122
|
flowchart LR
|
|
@@ -233,14 +146,135 @@ flowchart LR
|
|
|
233
146
|
|
|
234
147
|
**Just starting?** `/ls` or `/next` will route you into the right step automatically.
|
|
235
148
|
|
|
236
|
-
|
|
237
|
-
|
|
149
|
+
---
|
|
150
|
+
|
|
151
|
+
## 🏗️ How It Works
|
|
152
|
+
|
|
153
|
+

|
|
154
|
+
|
|
155
|
+
Three integrated layers that reinforce each other:
|
|
156
|
+
|
|
157
|
+
| Layer | What it does |
|
|
158
|
+
|-------|-------------|
|
|
159
|
+
| **Workflow Engine** | Spec-driven phases → context-engineered plans → wave-ordered execution → verified delivery |
|
|
160
|
+
| **Learning Partner** | Neuroscience-backed checkpoints at every phase transition: retrieval, reflection, spacing, struggle |
|
|
161
|
+
| **Design System** | 21 impeccable steering commands for production-grade UI: `/audit`, `/critique`, `/polish`, and more |
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
## 🌐 Platform Support
|
|
166
|
+
|
|
167
|
+

|
|
168
|
+
|
|
169
|
+
Each platform gets the best experience it supports:
|
|
170
|
+
|
|
171
|
+
| Feature | Windsurf | Claude Code | OpenCode | Gemini CLI | Codex CLI |
|
|
172
|
+
|---------|----------|-------------|----------|------------|-----------|
|
|
173
|
+
| Slash commands | ✓ | ✓ | ✓ | ✓ | `$skills` |
|
|
174
|
+
| Real parallel subagents | — | ✓ | ✓ | ✓ | ✓ |
|
|
175
|
+
| Parallel wave execution | — | ✓ opt-in | ✓ opt-in | ✓ | ✓ opt-in |
|
|
176
|
+
| Specialist agent pool | — | ✓ | ✓ | ✓ | ✓ |
|
|
177
|
+
| Interactive questions | `ask_user_question` | `AskUserQuestion` | `question` | `ask_user` | `request_user_input` |
|
|
178
|
+
| Session hooks | — | ✓ | — | ✓ | — |
|
|
179
|
+
| Skills (native `@invoke`) | ✓ | — | — | — | — |
|
|
180
|
+
| Skills (context files) | ✓ | ✓ | ✓ | ✓ | ✓ |
|
|
181
|
+
|
|
182
|
+
**Parallel subagents:** On Claude Code, OpenCode, and Codex, `execute-phase` can spawn a dedicated executor per plan within a wave, each with its own 200k context budget. Enable with `"parallelization": { "enabled": true }` in `.planning/config.json`. Up to 5 concurrent agents per wave by default. All platforms default to sequential (always safe).
|
|
183
|
+
|
|
184
|
+
---
|
|
185
|
+
|
|
186
|
+
## What is learnship?
|
|
187
|
+
|
|
188
|
+
learnship is an **agent harness** — the scaffolding that makes your AI coding agent actually reliable across real projects.
|
|
189
|
+
|
|
190
|
+
Every serious AI coding tool converges on the same architecture: a simple execution loop wraps the model, and the **harness** decides what information reaches the model, when, and how. The model is interchangeable. The harness is the product.
|
|
191
|
+
|
|
192
|
+
learnship gives you that harness as a portable, open-source layer that adds:
|
|
193
|
+
|
|
194
|
+
- **Persistent memory.** `/new-project` generates an `AGENTS.md` loaded automatically every session. No more repeating yourself.
|
|
195
|
+
- **Structured process.** A repeatable phase loop with spec-driven plans, wave-ordered execution, and UAT-driven verification.
|
|
196
|
+
- **Knowledge compounding.** `/compound` captures solved problems. `/review` runs multi-persona code review. `/ship` runs the full delivery pipeline.
|
|
197
|
+
- **Security & recovery.** `/secure-phase` for STRIDE verification. `/forensics` for post-mortem. `/undo` for safe revert.
|
|
198
|
+
- **Session intelligence.** Hooks, context profiles, interactive questions, agent delegation. ([v2.2 details →](#whats-new-in-v22))
|
|
199
|
+
- **Built-in learning.** Neuroscience-backed checkpoints at every phase transition so you understand what you shipped.
|
|
200
|
+
|
|
201
|
+
---
|
|
202
|
+
|
|
203
|
+
## What problem does it solve?
|
|
204
|
+
|
|
205
|
+
If you've used AI coding assistants for more than a few sessions, you've hit this wall:
|
|
206
|
+
|
|
207
|
+
> The agent forgets everything. Each session starts from scratch. Decisions get repeated. Code quality drifts. You ship fast but understand less.
|
|
208
|
+
|
|
209
|
+
This is a **harness problem**, not a model problem. The same model scores 42% with one scaffold and 78% with another. Same model. The only variable is the harness.
|
|
210
|
+
|
|
211
|
+
learnship solves this with **progressive disclosure** — context revealed incrementally, not dumped upfront. The right files, decisions, and phase context reach the agent exactly when needed.
|
|
212
|
+
|
|
213
|
+
| Without learnship | With learnship |
|
|
214
|
+
|-------------------|----------------|
|
|
215
|
+
| Context resets every session | `AGENTS.md` loaded automatically every conversation |
|
|
216
|
+
| Ad-hoc prompts, unpredictable results | Spec-driven plans, verifiable deliverables |
|
|
217
|
+
| Architectural decisions get forgotten | `DECISIONS.md` tracked and honored by the agent |
|
|
218
|
+
| Everything dumped into context at once | Phase-scoped context: only what this step needs |
|
|
219
|
+
| You ship code you don't fully understand | Learning checkpoints build real understanding at every step |
|
|
220
|
+
| UI looks generic, AI-generated | `impeccable` design system prevents AI aesthetic slop |
|
|
221
|
+
|
|
222
|
+
---
|
|
223
|
+
|
|
224
|
+
## Who is it for?
|
|
225
|
+
|
|
226
|
+
**Anyone who wants to build and ship real products with AI agents** — founders, designers, researchers, makers, not just developers.
|
|
227
|
+
|
|
228
|
+
It's the right tool if:
|
|
229
|
+
|
|
230
|
+
- You're **building a real project** and want the AI to stay aligned across sessions
|
|
231
|
+
- You're **learning while building** and want to actually understand what gets shipped
|
|
232
|
+
- You care about **code quality and UI quality** beyond "it works"
|
|
233
|
+
- You want **parallel agent execution** on Claude Code, OpenCode, or Gemini CLI
|
|
234
|
+
- You've felt the frustration of **context loss**: repeating yourself while the agent forgets
|
|
235
|
+
|
|
236
|
+
It's probably overkill for one-off scripts. Use `/quick` for that.
|
|
237
|
+
|
|
238
|
+
---
|
|
239
|
+
|
|
240
|
+
## 📚 Documentation
|
|
241
|
+
|
|
242
|
+
**[faviovazquez.github.io/learnship](https://faviovazquez.github.io/learnship/)**
|
|
243
|
+
|
|
244
|
+
- **[Getting Started](https://faviovazquez.github.io/learnship/getting-started/installation/)**: install, first project, the 5 commands
|
|
245
|
+
- **[Platform Guide](https://faviovazquez.github.io/learnship/platform-guide/windsurf/)**: Windsurf, Claude Code, Cursor, OpenCode, Gemini CLI, Codex CLI
|
|
246
|
+
- **[Core Concepts](https://faviovazquez.github.io/learnship/core-concepts/phase-loop/)**: phase loop, context engineering, planning artifacts
|
|
247
|
+
- **[Skills](https://faviovazquez.github.io/learnship/skills/agentic-learning/)**: 11 `@agentic-learning` actions + 21 `impeccable` design commands
|
|
248
|
+
- **[Workflow Reference](https://faviovazquez.github.io/learnship/workflow-reference/core/)**: all 57 workflows
|
|
249
|
+
- **[Configuration](https://faviovazquez.github.io/learnship/configuration/)**: full schema, speed presets, parallelization
|
|
250
|
+
|
|
251
|
+
---
|
|
252
|
+
|
|
253
|
+
## 🆕 What's New
|
|
254
|
+
|
|
255
|
+
### What's new in v2.2
|
|
256
|
+
|
|
257
|
+

|
|
258
|
+
|
|
259
|
+
v2.2 adds session intelligence, structured interactivity, and research templates:
|
|
260
|
+
|
|
261
|
+
**Session hooks** (Claude Code + Gemini CLI): 4 hooks installed via `settings.json` — statusline showing context usage, context monitor that warns before context runs out, prompt guard that scans `.planning/` writes for injection patterns, and session state that injects project orientation at startup.
|
|
262
|
+
|
|
263
|
+
**Context profiles**: Set `"context": "dev"` (default), `"research"`, or `"review"` in config.json to control agent output style. Switch with `/settings`.
|
|
264
|
+
|
|
265
|
+
**Interactive questions**: 14 workflows present decisions via your platform's native structured question tool — clickable cards on Claude Code, dropdowns on Windsurf, etc. `install.js` rewrites the tool name per platform automatically.
|
|
266
|
+
|
|
267
|
+
**Agent persona delegation**: 6 workflows spawn dedicated agents via `Task()` when parallelization is enabled, with `@./agents/` sequential fallback on all platforms.
|
|
268
|
+
|
|
269
|
+
**Research templates**: 5 structured fill-in-the-blanks templates (STACK.md, FEATURES.md, ARCHITECTURE.md, PITFALLS.md, SUMMARY.md) that prevent the AI from skipping file writes.
|
|
270
|
+
|
|
271
|
+
**Upgrade safety**: SHA-256 file manifest after every install. Locally modified files detected and backed up before overwriting. Run `/reapply-patches` to restore customizations.
|
|
238
272
|
|
|
239
273
|
### What's new in v2.1
|
|
240
274
|
|
|
241
275
|

|
|
242
276
|
|
|
243
|
-
v2.1 adds 8 new workflows, 5 new references, 3 new templates, and 2 new agents
|
|
277
|
+
v2.1 adds 8 new workflows, 5 new references, 3 new templates, and 2 new agents:
|
|
244
278
|
|
|
245
279
|
| Category | New workflows |
|
|
246
280
|
|----------|--------------|
|
|
@@ -252,31 +286,12 @@ v2.1 adds 8 new workflows, 5 new references, 3 new templates, and 2 new agents
|
|
|
252
286
|
|
|
253
287
|
Enhanced: `/discuss-phase` (scope guardrails + domain probes), `/execute-phase` (`--wave` flag + context scaling), `/quick` (`--research --validate --full` composable flags), `/ideate` (`--explore` Socratic mode).
|
|
254
288
|
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
## 🏗️ How It Works
|
|
258
|
-
|
|
259
|
-

|
|
260
|
-
|
|
261
|
-
Three integrated layers that reinforce each other:
|
|
262
|
-
|
|
263
|
-
| Layer | What it does |
|
|
264
|
-
|-------|-------------|
|
|
265
|
-
| **Workflow Engine** | Spec-driven phases → context-engineered plans → wave-ordered execution → verified delivery |
|
|
266
|
-
| **Learning Partner** | Neuroscience-backed checkpoints at every phase transition: retrieval, reflection, spacing, struggle |
|
|
267
|
-
| **Design System** | 21 impeccable steering commands for production-grade UI: `/audit`, `/critique`, `/polish`, and more |
|
|
268
|
-
|
|
269
|
-
```mermaid
|
|
270
|
-
graph LR
|
|
271
|
-
WE["Workflow Engine<br/>Spec-driven phases<br/>Context-engineered plans<br/>Atomic execution"] --> LP["Learning Partner<br/>Neuroscience-backed<br/>Woven into workflows<br/>Builds real understanding"]
|
|
272
|
-
WE --> DS["Design System<br/>Production-grade UI<br/>Impeccable aesthetics<br/>Anti-AI-slop standards"]
|
|
273
|
-
LP --> DS
|
|
274
|
-
DS --> LP
|
|
275
|
-
```
|
|
289
|
+
**Optional per-phase:** `/secure-phase N` (STRIDE security), `/extract-learnings N` (meta-knowledge).
|
|
290
|
+
**Recovery:** `/forensics` (post-mortem), `/undo` (safe revert).
|
|
276
291
|
|
|
277
292
|
---
|
|
278
293
|
|
|
279
|
-
##
|
|
294
|
+
## Agentic Engineering vs Vibe Coding
|
|
280
295
|
|
|
281
296
|

|
|
282
297
|
|
|
@@ -293,7 +308,7 @@ graph LR
|
|
|
293
308
|
|
|
294
309
|

|
|
295
310
|
|
|
296
|
-
Every agent invocation
|
|
311
|
+
Every agent invocation is loaded with structured context. Nothing is guessed:
|
|
297
312
|
|
|
298
313
|
```mermaid
|
|
299
314
|
flowchart LR
|
|
@@ -314,7 +329,7 @@ flowchart LR
|
|
|
314
329
|
|
|
315
330
|

|
|
316
331
|
|
|
317
|
-
`/new-project` generates an `AGENTS.md` at your project root. On Windsurf, Claude Code, and Cursor it
|
|
332
|
+
`/new-project` generates an `AGENTS.md` at your project root. On Windsurf, Claude Code, and Cursor it loads automatically every session. On other platforms, workflows reference it explicitly. Either way: the agent always knows the project, current phase, tech stack, and past decisions.
|
|
318
333
|
|
|
319
334
|
```
|
|
320
335
|
AGENTS.md ← your AI agent reads this every conversation
|
|
@@ -435,6 +450,7 @@ Project settings live in `.planning/config.json`. Set during `/new-project` or e
|
|
|
435
450
|
"granularity": "standard",
|
|
436
451
|
"model_profile": "balanced",
|
|
437
452
|
"learning_mode": "auto",
|
|
453
|
+
"context": "dev",
|
|
438
454
|
"test_first": false,
|
|
439
455
|
"planning": {
|
|
440
456
|
"commit_docs": true,
|
|
@@ -499,6 +515,7 @@ Project settings live in `.planning/config.json`. Set during `/new-project` or e
|
|
|
499
515
|
| `granularity` | `coarse`, `standard`, `fine` | `standard` | Phase size: 3-5 / 5-8 / 8-12 phases |
|
|
500
516
|
| `model_profile` | `quality`, `balanced`, `budget` | `balanced` | Agent model tier (see table below) |
|
|
501
517
|
| `learning_mode` | `auto`, `manual` | `auto` | `auto` offers learning at checkpoints; `manual` requires explicit invocation |
|
|
518
|
+
| `context` | `dev`, `research`, `review` | `dev` | Output profile: `dev` (concise), `research` (detailed), `review` (audit-focused) |
|
|
502
519
|
| `parallelization.enabled` | `true`, `false` | `false` | Parallel subagents per plan on supported platforms |
|
|
503
520
|
| `test_first` | `true`, `false` | `false` | TDD mode: write failing test first, verify red, implement, verify green |
|
|
504
521
|
| `planning.commit_mode` | `auto`, `manual` | `auto` | `auto` commits after each workflow step; `manual` skips all git commits |
|
package/SKILL.md
CHANGED
|
@@ -44,11 +44,32 @@ The following workflows are available as platform slash commands (Windsurf) or c
|
|
|
44
44
|
| `/extract-learnings [N]` | After phase completion — structured learning extraction |
|
|
45
45
|
| `/milestone-summary` | Generate comprehensive milestone summary for team onboarding |
|
|
46
46
|
|
|
47
|
+
## Context Profiles
|
|
48
|
+
|
|
49
|
+
Read `"context"` from `.planning/config.json` (default: `"dev"`). This controls your output style:
|
|
50
|
+
|
|
51
|
+
- **`dev`** — Concise, action-oriented. Bullet points, short paragraphs. Focus on what to do next.
|
|
52
|
+
- **`research`** — Verbose, exploratory. Trade-off analysis, alternatives considered, citations.
|
|
53
|
+
- **`review`** — Critical, audit-focused. Severity-ranked findings, evidence-based, nothing assumed safe.
|
|
54
|
+
|
|
55
|
+
The context profile files are at `@./contexts/dev.md`, `@./contexts/research.md`, `@./contexts/review.md`. Read the active one at the start of any workflow.
|
|
56
|
+
|
|
57
|
+
## Session Hooks (Claude Code + Gemini CLI)
|
|
58
|
+
|
|
59
|
+
On Claude Code and Gemini CLI, 4 hooks are installed via `settings.json`:
|
|
60
|
+
|
|
61
|
+
- **statusLine** — Shows model, task/phase, context usage bar
|
|
62
|
+
- **context-monitor** — Warns at 35% remaining (WARNING) and 25% remaining (CRITICAL)
|
|
63
|
+
- **prompt-guard** — Scans `.planning/` writes for injection patterns (advisory)
|
|
64
|
+
- **session-state** — Injects STATE.md orientation at session start
|
|
65
|
+
|
|
66
|
+
These are automatic — no workflow action needed. If context warnings appear, respect them.
|
|
67
|
+
|
|
47
68
|
## Planning Artifacts
|
|
48
69
|
|
|
49
70
|
All project state lives in `.planning/`. Key files:
|
|
50
71
|
|
|
51
|
-
- `.planning/config.json` — Settings including `learning_mode` ("auto" or "manual")
|
|
72
|
+
- `.planning/config.json` — Settings including `learning_mode` ("auto" or "manual"), `context` profile
|
|
52
73
|
- `.planning/PROJECT.md` — Vision, requirements, key decisions
|
|
53
74
|
- `.planning/ROADMAP.md` — Phase-by-phase delivery plan
|
|
54
75
|
- `.planning/STATE.md` — Current position, decisions, blockers
|
|
@@ -128,7 +149,7 @@ When running `/new-project`, these are non-negotiable hard gates. Violating any
|
|
|
128
149
|
|
|
129
150
|
1. **Research decision = always ask the user.** After PROJECT.md is confirmed, you MUST ask: "Do you want me to research the domain ecosystem first?" and WAIT for a reply. You are FORBIDDEN from deciding this yourself — even if the tech stack is defined in PROJECT.md, the domain seems trivial, or the user gave detailed answers. Never say "no research needed" or "skipping research" on your own.
|
|
130
151
|
|
|
131
|
-
2. **Research = 5
|
|
152
|
+
2. **Research = WRITE 5 FILES TO DISK.** "Research" means creating files, not thinking. If the user chooses research, you MUST write exactly 5 files to `.planning/research/`: `STACK.md`, `FEATURES.md`, `ARCHITECTURE.md`, `PITFALLS.md`, `SUMMARY.md`. Do NOT do web searches or domain analysis and then skip the file writes — that is a workflow failure. Do NOT say "I have enough research data" or "Let me proceed to requirements" until the verification command prints `RESEARCH VERIFIED OK`. The sequence is: mkdir → write 5 files → run verification → present findings → get user confirmation → THEN requirements.
|
|
132
153
|
|
|
133
154
|
3. **AGENTS.md = copy from template.** Read `@./templates/agents.md` BEFORE writing AGENTS.md. Sections marked "copy VERBATIM" must be copied word-for-word — do not rewrite, summarize, or rephrase them. After writing, run the `node -e` verification command. If it fails, fix AGENTS.md before proceeding.
|
|
134
155
|
|