@pathmode/cli 2.0.2 → 2.1.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 +25 -2
- package/dist/index.js +7300 -490
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -17,9 +17,15 @@ pathmode --version
|
|
|
17
17
|
You can also run it without installing:
|
|
18
18
|
|
|
19
19
|
```bash
|
|
20
|
-
npx @pathmode/cli
|
|
20
|
+
npx @pathmode/cli preflight
|
|
21
21
|
```
|
|
22
22
|
|
|
23
|
+
That runs the deterministic readiness gate on the `intent.md` in your directory, or on the
|
|
24
|
+
OpenSpec change your repo is working on, with no account and nothing leaving your machine. It
|
|
25
|
+
prints what it read for each dimension before the verdict, so a blocked check shows the text it
|
|
26
|
+
judged rather than just an accusation. Exits non-zero when the gate blocks, so it drops into CI
|
|
27
|
+
as-is.
|
|
28
|
+
|
|
23
29
|
## Quick start
|
|
24
30
|
|
|
25
31
|
```bash
|
|
@@ -28,7 +34,7 @@ pathmode login # paste your pm_live_ API key
|
|
|
28
34
|
pathmode init # write intent.md, .cursorrules, CLAUDE.md
|
|
29
35
|
```
|
|
30
36
|
|
|
31
|
-
`validate`
|
|
37
|
+
`preflight` and `validate` work with no account. The other five commands talk to the Pathmode API and need a key.
|
|
32
38
|
|
|
33
39
|
## Authentication
|
|
34
40
|
|
|
@@ -57,6 +63,7 @@ Environment variables take precedence over the config file, so use them in CI in
|
|
|
57
63
|
|
|
58
64
|
| Command | What it does | Needs auth |
|
|
59
65
|
|---|---|---|
|
|
66
|
+
| [`preflight`](#preflight-path) | Run the readiness gate on an intent.md or OpenSpec change | No |
|
|
60
67
|
| [`validate`](#validate-file) | Check a spec against the IntentSpec schema | No |
|
|
61
68
|
| [`login`](#login) | Store and verify your API key | Sets it up |
|
|
62
69
|
| [`init`](#init) | Scaffold intent files in a fresh repo | Yes |
|
|
@@ -64,6 +71,22 @@ Environment variables take precedence over the config file, so use them in CI in
|
|
|
64
71
|
| [`push`](#push) | Send status changes and notes back | Yes |
|
|
65
72
|
| [`status`](#status) | List workspace intents and their status | Yes |
|
|
66
73
|
|
|
74
|
+
### `preflight [path]`
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
pathmode preflight # ./intent.md, else the active OpenSpec change
|
|
78
|
+
pathmode preflight specs/login.md # a specific intent file
|
|
79
|
+
pathmode preflight openspec/changes/add-auth # an OpenSpec change directory
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Six deterministic checks: title, objective, outcomes, constraints, edge cases, verification. Pure
|
|
83
|
+
functions, no model call, no network; the same spec always gets the same verdict. A `?` means the
|
|
84
|
+
check read your text and could not confirm it, which is often the check's fixed vocabulary rather
|
|
85
|
+
than your writing. Reading an OpenSpec change writes nothing.
|
|
86
|
+
|
|
87
|
+
Exit codes: `0` ready, `1` the gate blocks, `2` nothing to grade. With several OpenSpec changes
|
|
88
|
+
present it refuses to guess and lists them.
|
|
89
|
+
|
|
67
90
|
### `validate [file]`
|
|
68
91
|
|
|
69
92
|
Validates the YAML frontmatter of a markdown file against the [IntentSpec schema](https://intentspec.org/schema.json). Exits `0` when valid and `1` when not, printing each failed field, so it works as a CI gate.
|