roadmapsmith 0.1.1 → 0.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/README.md +46 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -18,6 +18,31 @@ npx skills add PapiScholz/roadmapsmith --skill roadmap-sync
|
|
|
18
18
|
|
|
19
19
|
This adds the `roadmap-sync` agent skill. It does not install the CLI package.
|
|
20
20
|
|
|
21
|
+
## Operating Modes
|
|
22
|
+
|
|
23
|
+
### Zero Mode
|
|
24
|
+
|
|
25
|
+
Agent-guided discovery for empty or low-context repositories. The developer has a product idea but no implementation files, no stack decision, and no ROADMAP.md yet.
|
|
26
|
+
|
|
27
|
+
The CLI creates governance files. The AI agent (using the `roadmap-sync` skill) performs the discovery interview before generating the roadmap.
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
roadmapsmith init
|
|
31
|
+
roadmapsmith generate --project-root .
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Sync/Audit Mode
|
|
35
|
+
|
|
36
|
+
Repository-backed roadmap generation, validation, and synchronization. Use when the repository already has code, tests, docs, TODOs, or an existing ROADMAP.md.
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
roadmapsmith generate --project-root .
|
|
40
|
+
roadmapsmith validate --json
|
|
41
|
+
roadmapsmith sync --audit
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
21
46
|
## Commands
|
|
22
47
|
|
|
23
48
|
```bash
|
|
@@ -61,6 +86,27 @@ Create `roadmap-skill.config.json`:
|
|
|
61
86
|
{
|
|
62
87
|
"roadmapFile": "./ROADMAP.md",
|
|
63
88
|
"agentsFile": "./AGENTS.md",
|
|
89
|
+
|
|
90
|
+
// Forward-compatible fields — recognized by the skill/agent for Zero Mode discovery context,
|
|
91
|
+
// but not yet read by the generator or validator. Safe to add now; they will be wired in a future release.
|
|
92
|
+
"northStar": "Ship a self-hosted CLI tool for website capture and AI-readable design analysis.",
|
|
93
|
+
"targetUser": "Frontend developers, full-stack developers, and AI coding agents.",
|
|
94
|
+
"problemStatement": "Developers lack a unified tool to capture screenshots, crawl pages, extract assets, and export structured context.",
|
|
95
|
+
"v1Outcome": "A stable CLI that captures full-page screenshots, crawls internal links, exports metadata, and produces an AI-readable report.",
|
|
96
|
+
"antiGoals": [
|
|
97
|
+
"Do not bypass authentication",
|
|
98
|
+
"Do not target private systems without authorization"
|
|
99
|
+
],
|
|
100
|
+
"risks": [
|
|
101
|
+
"Browser automation instability",
|
|
102
|
+
"Scope creep into generic scraping"
|
|
103
|
+
],
|
|
104
|
+
"exitCriteria": [
|
|
105
|
+
"CLI works against a public test site",
|
|
106
|
+
"Screenshots and metadata are exported deterministically",
|
|
107
|
+
"README documents safe and authorized usage"
|
|
108
|
+
],
|
|
109
|
+
|
|
64
110
|
"taskMatchers": [
|
|
65
111
|
{
|
|
66
112
|
"pattern": "src/payments/",
|