ridgeline 0.7.11 → 0.7.13
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
CHANGED
|
@@ -5,35 +5,39 @@
|
|
|
5
5
|
Build harness for long-horizon software execution using AI agents.
|
|
6
6
|
|
|
7
7
|
Ridgeline decomposes large software ideas into phased builds using a
|
|
8
|
-
multi-agent pipeline (shaper, specifier, researcher, refiner, planner,
|
|
9
|
-
reviewer) driven by the Claude CLI. It manages state through git checkpoints,
|
|
8
|
+
multi-agent pipeline (shaper, designer, specifier, researcher, refiner, planner,
|
|
9
|
+
builder, reviewer) driven by the Claude CLI. It manages state through git checkpoints,
|
|
10
10
|
tracks costs, and supports resumable execution when things go wrong.
|
|
11
11
|
|
|
12
12
|
## How it works
|
|
13
13
|
|
|
14
14
|
1. **Shape** -- describe what you want built. The shaper agent analyzes your
|
|
15
15
|
codebase and asks clarifying questions to produce a structured shape document.
|
|
16
|
-
2. **
|
|
16
|
+
2. **Design** (optional) -- the designer agent establishes a visual design system
|
|
17
|
+
(`design.md`) through interactive Q&A. Auto-runs the asset catalog if assets
|
|
18
|
+
exist, and injects catalog context (detected style, palette, resolution) into
|
|
19
|
+
the design conversation. Works at build level or project level.
|
|
20
|
+
3. **Specify** -- an ensemble of three specialist agents (completeness, clarity,
|
|
17
21
|
pragmatism) drafts spec proposals, then a synthesizer merges them into
|
|
18
22
|
`spec.md`, `constraints.md`, and optionally `taste.md`.
|
|
19
|
-
|
|
23
|
+
4. **Research** (optional) -- an ensemble of research specialists (academic,
|
|
20
24
|
ecosystem, competitive) investigates the spec using web sources, then a
|
|
21
25
|
synthesizer merges findings into `research.md`. A gap analysis agenda step
|
|
22
26
|
runs before specialist dispatch to focus research on spec gaps. Findings
|
|
23
27
|
accumulate across iterations rather than being overwritten. A quick
|
|
24
28
|
single-agent mode is also available. See [Research and Refine](docs/research.md).
|
|
25
|
-
|
|
29
|
+
5. **Refine** (optional) -- the refiner agent rewrites `spec.md` incorporating
|
|
26
30
|
research findings and writes `spec.changelog.md` documenting what changed.
|
|
27
31
|
Additive by default -- adds insights without removing user-authored content.
|
|
28
|
-
|
|
32
|
+
6. **Plan** -- an ensemble of three specialist planners (simplicity,
|
|
29
33
|
thoroughness, velocity) proposes phase decompositions, then a synthesizer
|
|
30
34
|
merges them into numbered phase files with acceptance criteria.
|
|
31
|
-
|
|
35
|
+
7. **Build** -- for each phase the builder agent implements the spec inside your
|
|
32
36
|
repo, then creates a git checkpoint.
|
|
33
|
-
|
|
37
|
+
8. **Review** -- the reviewer agent (read-only) checks the output against the
|
|
34
38
|
acceptance criteria and returns a structured verdict. On failure, the harness
|
|
35
39
|
generates a feedback file from the verdict for the builder's next attempt.
|
|
36
|
-
|
|
40
|
+
9. **Retry or advance** -- failed phases are retried up to a configurable limit;
|
|
37
41
|
passing phases hand off context to the next one.
|
|
38
42
|
|
|
39
43
|
## Install
|
|
@@ -65,13 +69,17 @@ ridgeline my-feature "Build a REST API for task management"
|
|
|
65
69
|
|
|
66
70
|
# Or run each stage individually
|
|
67
71
|
ridgeline shape my-feature "Build a REST API for task management"
|
|
72
|
+
ridgeline design my-feature # optional: establish visual design system
|
|
68
73
|
ridgeline spec my-feature
|
|
69
|
-
ridgeline research my-feature --deep
|
|
70
|
-
ridgeline refine my-feature
|
|
74
|
+
ridgeline research my-feature --deep # optional: enrich spec with web research
|
|
75
|
+
ridgeline refine my-feature # optional: merge research into spec
|
|
71
76
|
ridgeline plan my-feature
|
|
72
77
|
ridgeline dry-run my-feature # preview before committing
|
|
73
78
|
ridgeline build my-feature
|
|
74
79
|
|
|
80
|
+
# Catalog media assets (images, audio, video, text)
|
|
81
|
+
ridgeline catalog my-feature --classify --describe
|
|
82
|
+
|
|
75
83
|
# Resume after a failure (re-run build)
|
|
76
84
|
ridgeline build my-feature
|
|
77
85
|
|
|
@@ -87,8 +95,8 @@ ridgeline clean
|
|
|
87
95
|
### `ridgeline [build-name] [input]` (default)
|
|
88
96
|
|
|
89
97
|
Auto-advances the build through the next incomplete pipeline stage
|
|
90
|
-
(shape → spec → plan → build; research and refine are opt-in).
|
|
91
|
-
flags from the individual commands.
|
|
98
|
+
(shape → spec → plan → build; design, research, and refine are opt-in).
|
|
99
|
+
Accepts all flags from the individual commands.
|
|
92
100
|
|
|
93
101
|
### `ridgeline shape [build-name] [input]`
|
|
94
102
|
|
|
@@ -102,6 +110,20 @@ path to an existing document or a natural language description.
|
|
|
102
110
|
| `--timeout <minutes>` | `10` | Max duration per turn |
|
|
103
111
|
| `--flavour <name-or-path>` | none | Agent flavour: built-in name or path to custom agents |
|
|
104
112
|
|
|
113
|
+
### `ridgeline design [build-name]`
|
|
114
|
+
|
|
115
|
+
Establishes or updates a visual design system through interactive Q&A. Produces
|
|
116
|
+
`design.md` in the build directory (or project-level if no build name is given).
|
|
117
|
+
If an asset directory exists but no catalog has been built, the catalog is
|
|
118
|
+
auto-run and its summary (detected style, palette, resolution, category
|
|
119
|
+
breakdown) is injected into the designer's context.
|
|
120
|
+
|
|
121
|
+
| Flag | Default | Description |
|
|
122
|
+
|------|---------|-------------|
|
|
123
|
+
| `--model <name>` | `opus` | Model for designer agent |
|
|
124
|
+
| `--timeout <minutes>` | `10` | Max duration per turn |
|
|
125
|
+
| `--flavour <name-or-path>` | none | Agent flavour: built-in name or path to custom agents |
|
|
126
|
+
|
|
105
127
|
### `ridgeline spec [build-name]`
|
|
106
128
|
|
|
107
129
|
Runs the specifier ensemble: three specialist agents (completeness, clarity,
|
|
@@ -191,7 +213,70 @@ Resets pipeline state to a given stage and deletes downstream artifacts.
|
|
|
191
213
|
|
|
192
214
|
| Flag | Default | Description |
|
|
193
215
|
|------|---------|-------------|
|
|
194
|
-
| `--to <stage>` | (required) | Stage to rewind to: `shape`, `spec`, `research`, `refine`, or `plan` |
|
|
216
|
+
| `--to <stage>` | (required) | Stage to rewind to: `shape`, `design`, `spec`, `research`, `refine`, or `plan` |
|
|
217
|
+
|
|
218
|
+
### `ridgeline catalog [build-name]`
|
|
219
|
+
|
|
220
|
+
Indexes media assets into `asset-catalog.json` — a structured metadata file that
|
|
221
|
+
feeds into the design and build phases. Supports images, audio, video, and text
|
|
222
|
+
files. The catalog pipeline runs in three tiers:
|
|
223
|
+
|
|
224
|
+
1. **Deterministic metadata** (always runs) — scans the asset directory, extracts
|
|
225
|
+
file metadata (size, hash, dimensions for images), detects spritesheets and
|
|
226
|
+
tileable textures, infers category from directory structure and filename
|
|
227
|
+
conventions (e.g., `characters/knight-walk.png` → category "characters",
|
|
228
|
+
subject "knight", state "walk"). Computes project-wide visual identity
|
|
229
|
+
aggregates (detected style, palette, resolution).
|
|
230
|
+
2. **Classification** (with `--classify`) — assigns categories to uncategorized
|
|
231
|
+
files. Filename heuristics run first (e.g., `bg_*` → backgrounds, `sfx_*` →
|
|
232
|
+
sfx). Files that don't match any pattern fall through to AI classification
|
|
233
|
+
using Claude vision for images or text prompts for other media types.
|
|
234
|
+
3. **Vision enrichment** (with `--describe`) — uses Claude vision to add semantic
|
|
235
|
+
descriptions, facing direction, pose, style tags, and animation type for image
|
|
236
|
+
assets. Layout and UI assets are auto-described regardless of the flag.
|
|
237
|
+
4. **Sprite packing** (with `--pack`) — groups image assets by category and packs
|
|
238
|
+
them into 2048×2048 sprite atlases with PixiJS-compatible JSON metadata.
|
|
239
|
+
Backgrounds and layout references are excluded.
|
|
240
|
+
|
|
241
|
+
The catalog is incremental — unchanged files (by content hash) are skipped on
|
|
242
|
+
subsequent runs unless `--force` is set.
|
|
243
|
+
|
|
244
|
+
| Flag | Default | Description |
|
|
245
|
+
|------|---------|-------------|
|
|
246
|
+
| `--asset-dir <path>` | auto | Path to asset directory |
|
|
247
|
+
| `--classify` | off | AI-classify uncategorized files into categories |
|
|
248
|
+
| `--describe` | off | Add vision-based descriptions for all image assets |
|
|
249
|
+
| `--pack` | off | Generate sprite atlases after cataloging |
|
|
250
|
+
| `--batch` | off | Batch multiple images per vision call |
|
|
251
|
+
| `--force` | off | Re-process all assets ignoring content hash |
|
|
252
|
+
| `--model <name>` | `opus` | Model for vision and classification |
|
|
253
|
+
| `--timeout <minutes>` | `5` | Max duration per AI call |
|
|
254
|
+
|
|
255
|
+
Asset directory is resolved in order: `--asset-dir` flag,
|
|
256
|
+
`.ridgeline/builds/<build-name>/assets/`, `.ridgeline/assets/`, or the
|
|
257
|
+
`assetDir` field in `settings.json`.
|
|
258
|
+
|
|
259
|
+
### `ridgeline retrospective [build-name]`
|
|
260
|
+
|
|
261
|
+
Analyzes a completed build and extracts learnings for future builds. Reads the
|
|
262
|
+
trajectory log, budget, state, and any feedback files, then appends structured
|
|
263
|
+
insights to `.ridgeline/learnings.md`. Future builds automatically pick up these
|
|
264
|
+
learnings if the file exists.
|
|
265
|
+
|
|
266
|
+
| Flag | Default | Description |
|
|
267
|
+
|------|---------|-------------|
|
|
268
|
+
| `--model <name>` | `opus` | Model for retrospective agent |
|
|
269
|
+
| `--timeout <minutes>` | `10` | Max duration |
|
|
270
|
+
| `--flavour <name-or-path>` | none | Agent flavour: built-in name or path to custom agents |
|
|
271
|
+
|
|
272
|
+
### `ridgeline check`
|
|
273
|
+
|
|
274
|
+
Checks recommended tools and prerequisites for a flavour. Reports which
|
|
275
|
+
external tools are available and which are missing.
|
|
276
|
+
|
|
277
|
+
| Flag | Default | Description |
|
|
278
|
+
|------|---------|-------------|
|
|
279
|
+
| `--flavour <name-or-path>` | from settings | Agent flavour to check |
|
|
195
280
|
|
|
196
281
|
### `ridgeline clean`
|
|
197
282
|
|
|
@@ -203,15 +288,19 @@ WIP branches. Use this after inspecting a failed build.
|
|
|
203
288
|
```text
|
|
204
289
|
.ridgeline/
|
|
205
290
|
├── settings.json # Optional project-level config (network allowlist, etc.)
|
|
291
|
+
├── design.md # Optional project-level visual design system
|
|
292
|
+
├── learnings.md # Optional accumulated build learnings (from retrospective)
|
|
206
293
|
├── worktrees/ # Git worktrees for active builds
|
|
207
294
|
│ └── <build-name>/ # Isolated working directory per build
|
|
208
295
|
└── builds/<build-name>/
|
|
209
296
|
├── shape.md # Structured project context (from shaper)
|
|
297
|
+
├── design.md # Optional visual design system (from designer)
|
|
210
298
|
├── spec.md # What to build
|
|
211
299
|
├── constraints.md # Technical constraints and check commands
|
|
212
300
|
├── taste.md # Optional coding style preferences
|
|
213
301
|
├── research.md # Optional research findings (from researcher)
|
|
214
302
|
├── spec.changelog.md # Optional changelog of spec refinements
|
|
303
|
+
├── asset-catalog.json # Optional indexed media assets (from catalog)
|
|
215
304
|
├── phases/
|
|
216
305
|
│ ├── 01-scaffold.md
|
|
217
306
|
│ ├── 01-scaffold.feedback.md # Generated by harness on review failure
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: agent-browser
|
|
3
3
|
description: Capture annotated browser screenshots with numbered element labels for visual verification. Use when building or reviewing web UIs, verifying responsive layouts, checking visual output of canvas/WebGL content, or inspecting rendered pages. Trigger when asked to screenshot, verify layout, check rendering, or visually inspect a running web app.
|
|
4
|
-
compatibility: Requires agent-browser CLI (npm i -g
|
|
4
|
+
compatibility: Requires agent-browser CLI (npm i -g agent-browser)
|
|
5
5
|
metadata:
|
|
6
6
|
author: ridgeline
|
|
7
7
|
version: "1.0"
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: canvas-screenshot
|
|
3
3
|
description: Capture rendered canvas and WebGL frames from browser-based games and visual applications. Use when verifying canvas rendering, checking WebGL output, capturing game screenshots, or validating visual output from PixiJS, Phaser, Three.js, or raw canvas apps.
|
|
4
|
-
compatibility: Requires agent-browser CLI (npm i -g
|
|
4
|
+
compatibility: Requires agent-browser CLI (npm i -g agent-browser) or Playwright (npm i -g playwright)
|
|
5
5
|
metadata:
|
|
6
6
|
author: ridgeline
|
|
7
7
|
version: "1.0"
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: shader-validate
|
|
3
3
|
description: Validate and cross-compile GLSL, WGSL, and SPIR-V shaders using naga. Use when writing shaders, checking shader compilation, debugging shader errors, converting between shader languages, or verifying WebGL/WebGPU shader code.
|
|
4
|
-
compatibility: Requires naga
|
|
4
|
+
compatibility: Requires naga (cargo install naga-cli)
|
|
5
5
|
metadata:
|
|
6
6
|
author: ridgeline
|
|
7
7
|
version: "1.0"
|