create-pathfinder 1.5.1 → 1.6.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/AGENTS.md +1 -1
- package/README.md +14 -24
- package/package.json +2 -2
- package/src/cli.mjs +781 -82
- package/src/install.mjs +30 -2
- package/src/kit.mjs +16 -0
- package/src/progress.mjs +144 -0
- package/src/theme.mjs +362 -0
package/AGENTS.md
CHANGED
|
@@ -8,4 +8,4 @@ Use the smallest relevant context for the active task. Keep each delivery chunk
|
|
|
8
8
|
|
|
9
9
|
Canonical skills live under `skills/` and are the only behavior contract; anything under `.claude/skills/` or `.agents/skills/` is a generated pointer to one, so edit the canonical file and regenerate the adapter.
|
|
10
10
|
|
|
11
|
-
If this tool has no native skill discovery, invoke a skill by reading its canonical file directly: `Use skills/<name>/SKILL.md and follow it exactly.` That is the whole fallback —
|
|
11
|
+
If this tool has no native skill discovery, invoke a skill by reading its canonical file directly: `Use skills/<name>/SKILL.md and follow it exactly.` That is the whole fallback — one line, and no second copy of a skill anywhere to find.
|
package/README.md
CHANGED
|
@@ -2,12 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
**An AI-assisted, human-in-the-loop workflow for building software — without giving up the decisions.**
|
|
4
4
|
|
|
5
|
-
This package installs [Pathfinder](https://
|
|
5
|
+
This package installs [Pathfinder](https://pathfinder-kit.vercel.app) into a Git repository — one you already have, or one it offers to create for you.
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
8
|
npx create-pathfinder
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
+
That is the whole invocation. This is a scaffolding CLI you run once, not a dependency: `npm i create-pathfinder` would add it to your project's `package.json` and `node_modules` without installing anything into your repository. If you would rather not use `npx`, `npm exec create-pathfinder` is equivalent, and a global install (`npm i -g create-pathfinder`) gives you a `create-pathfinder` command that behaves identically.
|
|
12
|
+
|
|
11
13
|
Then give your agent this prompt:
|
|
12
14
|
|
|
13
15
|
```text
|
|
@@ -15,9 +17,11 @@ Use skills/kickstart-pathfinder/SKILL.md. Help me initialize this project.
|
|
|
15
17
|
Do not install packages or write product code yet.
|
|
16
18
|
```
|
|
17
19
|
|
|
20
|
+
Everything below is what the command does. **What Pathfinder is, how the workflow runs, and what each skill does are documented at [pathfinder-kit.vercel.app](https://pathfinder-kit.vercel.app).**
|
|
21
|
+
|
|
18
22
|
## What it installs
|
|
19
23
|
|
|
20
|
-
|
|
24
|
+
The installer copies five things into your repository and nothing else:
|
|
21
25
|
|
|
22
26
|
| Path | What it is |
|
|
23
27
|
| --- | --- |
|
|
@@ -59,25 +63,14 @@ npx create-pathfinder --agents claude-code,codex
|
|
|
59
63
|
| `claude-code` | `.claude/skills/<name>/SKILL.md` | `/reflect` |
|
|
60
64
|
| `codex` | `.agents/skills/<name>/SKILL.md` | `/skills`, or `$reflect` |
|
|
61
65
|
|
|
62
|
-
Each adapter
|
|
66
|
+
Each adapter carries the skill's name and description and tells the tool to read the canonical file — the behavior lives in one place, and the adapter never restates it.
|
|
63
67
|
|
|
64
68
|
Pick one, both, or neither. Choosing one never generates, removes, or claims anything under the other's directory, and Pathfinder never writes to a personal skills directory such as `$HOME/.agents/skills`.
|
|
65
69
|
|
|
66
|
-
In a terminal you are asked instead of passing the flag — a numbered list, comma-separated, `Enter` for the tools found on your machine, `0` for none. Each option shows the directory it writes to before you choose it.
|
|
67
|
-
|
|
68
|
-
The list has a third entry, **Something else…**, and it generates nothing. Name your tool and the summary says so plainly, because a `.mdc` file Cursor half-reads or a `SKILL.md` in a directory nothing scans would be a file your tool ignores under a summary claiming success. Two things do work for any tool: the kit installs `AGENTS.md` at the repository root, which Codex, Cursor, and several others read, and any agent can be given the line the adapters delegate to anyway — `Use skills/<name>/SKILL.md and follow it exactly.`
|
|
70
|
+
In a terminal you are asked instead of passing the flag — a numbered list, comma-separated, `Enter` for the tools found on your machine, `0` for none. Each option shows the directory it writes to before you choose it. A third entry, **Something else…**, generates nothing and says so: the kit still installs `AGENTS.md` at the repository root, which Codex, Cursor, and several others read, and any agent can be given the line the adapters delegate to — `Use skills/<name>/SKILL.md and follow it exactly.`
|
|
69
71
|
|
|
70
72
|
Nothing is configured unless you choose it. Detection only sets the default, a piped or scripted run configures nothing at all unless `--agents` says so, and `--agents` accepts only the ids in the table above — an unknown one exits 2 rather than quietly installing nothing.
|
|
71
73
|
|
|
72
|
-
**What the installer owns, and what it will not touch:**
|
|
73
|
-
|
|
74
|
-
- **It owns a file at `<tool>/skills/<name>/SKILL.md` only if that name is a Pathfinder skill *and* the file carries the `pathfinder:adapter` marker it wrote.** Those it regenerates freely, with no flag — that is how an older install gains adapters by re-running.
|
|
75
|
-
- **A file you wrote at one of those paths is left alone** and listed by name in the summary. `--force` replaces it; nothing else does.
|
|
76
|
-
- **Everything else under that directory is never read and never written** — your `settings.json`, `settings.local.json`, agents, commands, hooks, and any skill of your own.
|
|
77
|
-
- **Nothing is ever deleted.** An adapter for a skill a newer version no longer ships is reported and left in place.
|
|
78
|
-
|
|
79
|
-
Re-running is idempotent: the second run writes the same bytes and reports the adapters as already up to date.
|
|
80
|
-
|
|
81
74
|
## The Kickstart prompt, and your clipboard
|
|
82
75
|
|
|
83
76
|
Every install ends by printing the one prompt that starts a session, and the prompt follows the tool you chose:
|
|
@@ -88,16 +81,14 @@ Every install ends by printing the one prompt that starts a session, and the pro
|
|
|
88
81
|
| `codex` | `$kickstart-pathfinder` |
|
|
89
82
|
| both, or neither | `Use skills/kickstart-pathfinder/SKILL.md. Help me initialize this project. Do not install packages or write product code yet.` |
|
|
90
83
|
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
In a terminal you are then asked whether to copy it. The question says what it replaces, because your clipboard is yours:
|
|
84
|
+
In a terminal you are then asked whether to copy it, in a question that says what it replaces:
|
|
94
85
|
|
|
95
86
|
```text
|
|
96
87
|
? Copy that prompt to your clipboard? This replaces what is on it now. [Y/n]
|
|
97
88
|
```
|
|
98
89
|
|
|
99
90
|
- **Nothing is copied without an explicit yes.** Declining, an unanswered question, `--no-clipboard`, `--yes`, `--dry-run`, and any run without a terminal on both ends all leave your clipboard exactly as it was.
|
|
100
|
-
- **The prompt is printed either way.** Copying is a convenience, never the only way to get it
|
|
91
|
+
- **The prompt is printed either way.** Copying is a convenience, never the only way to get it.
|
|
101
92
|
- **No dependency, and no clipboard is ever read.** The copy uses whatever your system already has — `pbcopy`, `clip.exe` including under WSL, or `wl-copy`, `xclip`, or `xsel` — chosen by what is actually installed rather than by your platform's name. If none of them is there, or one of them fails, the installer says so in one line and still exits 0.
|
|
102
93
|
|
|
103
94
|
## Opening the project
|
|
@@ -108,12 +99,10 @@ The last question is whether to open the project, and it is only ever about an e
|
|
|
108
99
|
- **Several found** — a numbered list, alphabetical, ending in `Don't open`
|
|
109
100
|
- **None found** — no question at all
|
|
110
101
|
|
|
111
|
-
Neither editor is a Pathfinder requirement, and the alphabetical order is not a recommendation.
|
|
112
|
-
|
|
113
|
-
The launch is detached — the installer hands over the project directory and exits immediately, so it never waits for your editor and never prints your editor's output as its own.
|
|
102
|
+
Neither editor is a Pathfinder requirement, and the alphabetical order is not a recommendation. There is no way to name an editor or pass a path. The launch is detached: the installer hands over the project directory and exits immediately.
|
|
114
103
|
|
|
115
104
|
- **Nothing is launched without an explicit yes.** Declining, an unanswered question, `Don't open`, `--no-open`, `--yes`, `--dry-run`, and any run without a terminal on both ends all leave your screen alone.
|
|
116
|
-
- **A failed launch is not a failed install.** If the binary is there but cannot be run, the installer says so in one line, tells you the directory to open yourself, and still exits 0.
|
|
105
|
+
- **A failed launch is not a failed install.** If the binary is there but cannot be run, the installer says so in one line, tells you the directory to open yourself, and still exits 0.
|
|
117
106
|
|
|
118
107
|
## Options
|
|
119
108
|
|
|
@@ -141,7 +130,8 @@ No dependencies — this package installs nothing into your project's `node_modu
|
|
|
141
130
|
|
|
142
131
|
## Links
|
|
143
132
|
|
|
144
|
-
- [
|
|
133
|
+
- [Documentation](https://pathfinder-kit.vercel.app)
|
|
134
|
+
- [Repository](https://github.com/rikilamadrid/pathfinder)
|
|
145
135
|
- [Why this is not a framework](https://github.com/rikilamadrid/pathfinder/blob/main/NOT_A_FRAMEWORK.md)
|
|
146
136
|
- [Changelog](https://github.com/rikilamadrid/pathfinder/blob/main/CHANGELOG.md)
|
|
147
137
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-pathfinder",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.6.0",
|
|
4
4
|
"description": "Install the Pathfinder AI-assisted, human-in-the-loop workflow kit into a Git repository.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"pathfinder",
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
],
|
|
14
14
|
"license": "MIT",
|
|
15
15
|
"author": "Ricardo Lamadrid (Lamadrid Labs)",
|
|
16
|
-
"homepage": "https://
|
|
16
|
+
"homepage": "https://pathfinder-kit.vercel.app",
|
|
17
17
|
"bugs": "https://github.com/rikilamadrid/pathfinder/issues",
|
|
18
18
|
"repository": {
|
|
19
19
|
"type": "git",
|