scriveno 2.0.11 → 2.5.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 +17 -8
- package/bin/install.js +91 -2
- package/commands/scr/demo.md +1 -0
- package/commands/scr/first-run.md +128 -0
- package/commands/scr/help.md +1 -0
- package/commands/scr/new-work.md +1 -1
- package/data/CONSTRAINTS.json +10 -1
- package/data/proof/first-run/README.md +96 -0
- package/data/proof/runtime-parity/README.md +48 -0
- package/docs/architecture.md +3 -1
- package/docs/command-reference.md +17 -1
- package/docs/configuration.md +1 -1
- package/docs/contributing.md +7 -2
- package/docs/development.md +15 -3
- package/docs/getting-started.md +9 -4
- package/docs/proof-artifacts.md +16 -0
- package/docs/quick-proof.md +195 -0
- package/docs/release-checklist.md +117 -0
- package/docs/release-notes.md +72 -0
- package/docs/route-graph.md +2 -2
- package/docs/runtime-support.md +14 -0
- package/docs/sacred-texts.md +1 -1
- package/docs/shipped-assets.md +5 -0
- package/docs/starter-sets.md +82 -0
- package/docs/testing.md +18 -3
- package/docs/voice-dna.md +1 -1
- package/docs/work-types.md +1 -1
- package/package.json +4 -2
- package/scripts/check-writing-policy.js +86 -0
- package/templates/config.json +1 -1
package/docs/contributing.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Scriveno is a pure skill system -- markdown files that AI agents read and execute. There is no compiled code, no build step, no runtime dependencies. Contributing means adding or editing markdown files and updating the central constraint registry.
|
|
4
4
|
|
|
5
|
-
This guide walks you through extending Scriveno: adding commands, agents, work types, templates, and export formats. Each section is self-contained -- jump to what you need.
|
|
5
|
+
This guide walks you through extending Scriveno: adding commands, agents, work types, templates, and export formats. Each section is self-contained -- jump to what you need. For release operations, use [Release Checklist](release-checklist.md).
|
|
6
6
|
|
|
7
7
|
## File Structure Overview
|
|
8
8
|
|
|
@@ -379,6 +379,9 @@ When a package release changes the public story, update the release docs alongsi
|
|
|
379
379
|
- `CHANGELOG.md` -- package-level release history
|
|
380
380
|
- `docs/release-notes.md` -- public-facing summary of what changed and why it matters
|
|
381
381
|
- `README.md` -- current version/status blurb when the release changes the headline positioning
|
|
382
|
+
- `docs/quick-proof.md` -- proof-first first-run route when install, demo, or proof expectations change
|
|
383
|
+
- `docs/starter-sets.md` -- goal-based command paths when command positioning changes
|
|
384
|
+
- `docs/release-checklist.md` -- publish workflow when release validation changes
|
|
382
385
|
- `docs/shipped-assets.md` -- canonical inventory when bundled docs, templates, proof assets, or trust-critical files change
|
|
383
386
|
- `docs/command-reference.md` -- command contract reference when command behavior or flags change
|
|
384
387
|
- `docs/auto-invoke-policy.md` -- proactive routing, safe apply, local-helper, and agent-spawn policy
|
|
@@ -395,7 +398,9 @@ When a package release changes the public story, update the release docs alongsi
|
|
|
395
398
|
4. Run `npm test`
|
|
396
399
|
5. Run `npm run release:check`
|
|
397
400
|
6. For runtime, installer, agent, sync, or route-intelligence changes, run `scriveno sync --check`, `scriveno smoke --json`, `scriveno agents --json`, and `scriveno routes --json`
|
|
398
|
-
7.
|
|
401
|
+
7. For docs, prompts, command markdown, release notes, and README changes, run `npm run policy:check`
|
|
402
|
+
8. Follow [Release Checklist](release-checklist.md) before publishing
|
|
403
|
+
9. Publish only after the docs and package metadata tell the same story
|
|
399
404
|
|
|
400
405
|
## Code Style
|
|
401
406
|
|
package/docs/development.md
CHANGED
|
@@ -106,6 +106,12 @@ Run the release gate before publishing:
|
|
|
106
106
|
npm run release:check
|
|
107
107
|
```
|
|
108
108
|
|
|
109
|
+
Run the writing-policy gate directly when changing docs, prompts, commands, release notes, or public copy:
|
|
110
|
+
|
|
111
|
+
```bash
|
|
112
|
+
npm run policy:check
|
|
113
|
+
```
|
|
114
|
+
|
|
109
115
|
Start the installer locally:
|
|
110
116
|
|
|
111
117
|
```bash
|
|
@@ -143,6 +149,9 @@ For release-oriented documentation surfaces, the main files are:
|
|
|
143
149
|
|
|
144
150
|
- `README.md`
|
|
145
151
|
- `CHANGELOG.md`
|
|
152
|
+
- `docs/quick-proof.md`
|
|
153
|
+
- `docs/starter-sets.md`
|
|
154
|
+
- `docs/release-checklist.md`
|
|
146
155
|
- `docs/release-notes.md`
|
|
147
156
|
- `docs/shipped-assets.md`
|
|
148
157
|
- `docs/command-reference.md`
|
|
@@ -158,9 +167,10 @@ A good pre-ship pass for Scriveno changes is:
|
|
|
158
167
|
|
|
159
168
|
1. run the targeted tests for the touched surface
|
|
160
169
|
2. run `npm test`
|
|
161
|
-
3. run `npm run
|
|
162
|
-
4. run
|
|
163
|
-
5.
|
|
170
|
+
3. run `npm run policy:check` for docs, command, agent, prompt, and release-note changes
|
|
171
|
+
4. run `npm run release:check` for package-facing changes
|
|
172
|
+
5. run the proactive audit commands when routing, runtime, installer, or agent surfaces changed
|
|
173
|
+
6. review trust-sensitive docs for runtime, asset, and support claims
|
|
164
174
|
|
|
165
175
|
## Related docs
|
|
166
176
|
|
|
@@ -168,6 +178,8 @@ A good pre-ship pass for Scriveno changes is:
|
|
|
168
178
|
- [Configuration](configuration.md)
|
|
169
179
|
- [Testing](testing.md)
|
|
170
180
|
- [Contributing](contributing.md)
|
|
181
|
+
- [Quick Proof](quick-proof.md)
|
|
182
|
+
- [Release Checklist](release-checklist.md)
|
|
171
183
|
- [Auto-Invoke Policy](auto-invoke-policy.md)
|
|
172
184
|
- [Runtime Support](runtime-support.md)
|
|
173
185
|
- [Route Graph Audit](route-graph.md)
|
package/docs/getting-started.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Go from zero to a drafted scene in under 10 minutes. This guide walks you through installation, project setup, and your first draft.
|
|
4
4
|
|
|
5
|
-
Want evidence first? Start with [Proof Artifacts](proof-artifacts.md). The watchmaker sample flow and the Voice DNA before/after bundle give you the fastest way to inspect what Scriveno actually proves today.
|
|
5
|
+
Want evidence first? Start with [Quick Proof](quick-proof.md), then continue to [Proof Artifacts](proof-artifacts.md). The watchmaker sample flow and the Voice DNA before/after bundle give you the fastest way to inspect what Scriveno actually proves today.
|
|
6
6
|
|
|
7
7
|
## Prerequisites
|
|
8
8
|
|
|
@@ -22,12 +22,13 @@ npx scriveno@latest
|
|
|
22
22
|
|
|
23
23
|
This installs Scriveno into the runtime you choose. Command-directory and skills targets place files where the runtime expects them. Guided targets like Perplexity Desktop instead write setup assets and show the exact connector steps you need. Takes about 30 seconds.
|
|
24
24
|
|
|
25
|
-
Once installed, Claude Code uses flat `/scr-*` commands such as `/scr-help
|
|
25
|
+
Once installed, Claude Code uses flat `/scr-*` commands such as `/scr-help`, `/scr-first-run`, and `/scr-new-work`. Other command-directory runtimes currently keep `/scr:*`. Codex uses generated `$scr-*` skills such as `$scr-help`, `$scr-first-run`, and `$scr-new-work`. Guided targets explain their supported setup path directly in the generated setup files.
|
|
26
26
|
|
|
27
27
|
You can also ask Scriveno for a read-only project status from any terminal:
|
|
28
28
|
|
|
29
29
|
```
|
|
30
30
|
scriveno status --project .
|
|
31
|
+
scriveno first-run --project .
|
|
31
32
|
scriveno status . --json
|
|
32
33
|
scriveno status --project . --apply-safe
|
|
33
34
|
scriveno sync --check
|
|
@@ -37,6 +38,8 @@ That status command is the same shared auto-invoke engine used by `/scr-next`, `
|
|
|
37
38
|
|
|
38
39
|
Use `--apply-safe` when you want Scriveno to run the read-only checks and show which helpers are safe, skipped, or agent-ready. Use `sync --check` when you want the installed runtime surfaces checked too.
|
|
39
40
|
|
|
41
|
+
If you want one guided proof path instead of separate checks, start with `scriveno first-run --project .`.
|
|
42
|
+
|
|
40
43
|
## Step 2: Explore the Demo (Optional)
|
|
41
44
|
|
|
42
45
|
Not sure what Scriveno does? Try the demo before starting your own project:
|
|
@@ -63,7 +66,7 @@ This creates a pre-built short story project -- a retired watchmaker who receive
|
|
|
63
66
|
|
|
64
67
|
Explore at your own pace. When you're ready to start your own work, run `/scr-demo --clear` to clean up.
|
|
65
68
|
|
|
66
|
-
If you want a curated reading path instead of jumping straight into the demo files, open [Proof
|
|
69
|
+
If you want a curated reading path instead of jumping straight into the demo files, open [Quick Proof](quick-proof.md) first. It maps the install checks, runtime command shapes, watchmaker demo, and next draft into one 10-minute path.
|
|
67
70
|
|
|
68
71
|
## Step 3: Start Your Project
|
|
69
72
|
|
|
@@ -204,11 +207,13 @@ Beyond the core workflow, Scriveno offers:
|
|
|
204
207
|
- **Versions** -- `/scr-save`, `/scr-history`, `/scr-versions`, `/scr-compare`
|
|
205
208
|
- **Navigation** -- `/scr-help`, `/scr-next`, `/scr-pause-work`
|
|
206
209
|
|
|
207
|
-
For the full command list, see [Command Reference](command-reference.md).
|
|
210
|
+
For small goal-based paths, use [Starter Sets](starter-sets.md). For the full command list, see [Command Reference](command-reference.md).
|
|
208
211
|
|
|
209
212
|
If you want the trust surfaces around installation and shipping details, continue with:
|
|
210
213
|
|
|
211
214
|
- [Runtime Support](runtime-support.md) -- installer targets, support levels, and verification status
|
|
215
|
+
- [Quick Proof](quick-proof.md) -- proof-first first-run path through install, demo, and next draft
|
|
216
|
+
- [Starter Sets](starter-sets.md) -- small command sets by writing goal
|
|
212
217
|
- [Auto-Invoke Policy](auto-invoke-policy.md) -- status engine, visible automation, and agent-spawn boundaries
|
|
213
218
|
- [Route Graph Audit](route-graph.md) -- generated route graph, automation lanes, and priority fixtures
|
|
214
219
|
- [Shipped Assets](shipped-assets.md) -- what the npm package actually includes on the trust-critical surface
|
package/docs/proof-artifacts.md
CHANGED
|
@@ -4,10 +4,14 @@ This document is the canonical index of Scriveno's proof layer. It points to con
|
|
|
4
4
|
|
|
5
5
|
## Start Here
|
|
6
6
|
|
|
7
|
+
- Read **Quick Proof** if you want one 10-minute route through installation checks, demo inspection, runtime command shapes, and the next draft command.
|
|
8
|
+
- Read **First-Run Proof** if you want the committed transcript artifact for `/scr:first-run`, `scriveno first-run --project .`, runtime smoke, and the demo flow.
|
|
7
9
|
- Read the **Watchmaker Sample Flow** if you want one end-to-end writing workflow from setup through drafts, review, and next step.
|
|
8
10
|
- Read **Voice DNA** if you want the shortest possible proof of how style guidance changes output on the same brief.
|
|
9
11
|
- Read **Creative Context** if you want to see one craft choice travel through discuss, plan, draft, and review artifacts.
|
|
10
12
|
|
|
13
|
+
**Fast path:** [Quick Proof](quick-proof.md)
|
|
14
|
+
|
|
11
15
|
## Watchmaker Sample Flow
|
|
12
16
|
|
|
13
17
|
**What it proves:** Scriveno ships one credible writing workflow from setup context through drafted outcome, review evidence, and next-step continuity.
|
|
@@ -29,6 +33,14 @@ This document is the canonical index of Scriveno's proof layer. It points to con
|
|
|
29
33
|
|
|
30
34
|
Start with the proof bundle if you want the curated version. Follow the underlying files if you want to inspect the raw sample directly.
|
|
31
35
|
|
|
36
|
+
## First-Run Proof
|
|
37
|
+
|
|
38
|
+
**What it proves:** Scriveno has an executable first-run guide and committed transcript artifacts for the first proof path.
|
|
39
|
+
|
|
40
|
+
**Canonical artifact:** [data/proof/first-run/README.md](../data/proof/first-run/README.md)
|
|
41
|
+
|
|
42
|
+
**Related parity artifact:** [data/proof/runtime-parity/README.md](../data/proof/runtime-parity/README.md)
|
|
43
|
+
|
|
32
44
|
## Voice DNA
|
|
33
45
|
|
|
34
46
|
**What it proves:** Scriveno's style-guide layer changes draft behavior in visible ways when the same brief is written unguided versus guided.
|
|
@@ -52,6 +64,10 @@ Read the bundle in order if you want to inspect sentence rhythm, metaphor select
|
|
|
52
64
|
## Related Trust Docs
|
|
53
65
|
|
|
54
66
|
- [Shipped Assets](shipped-assets.md) -- canonical inventory of the trust-critical files Scriveno actually bundles
|
|
67
|
+
- [Quick Proof](quick-proof.md) -- 10-minute proof-first path through install checks, the demo, and the next draft
|
|
68
|
+
- [Starter Sets](starter-sets.md) -- small command sets by writing goal
|
|
69
|
+
- [data/proof/first-run/README.md](../data/proof/first-run/README.md) -- committed first-run transcript artifact
|
|
70
|
+
- [data/proof/runtime-parity/README.md](../data/proof/runtime-parity/README.md) -- runtime surface evidence and host-parity boundary
|
|
55
71
|
- [Runtime Support](runtime-support.md) -- canonical runtime matrix and installer-baseline framing
|
|
56
72
|
- [Auto-Invoke Policy](auto-invoke-policy.md) -- proactive status, safe apply, local-helper, and agent-spawn boundaries
|
|
57
73
|
- [Route Graph Audit](route-graph.md) -- generated route graph, automation lanes, and priority fixtures
|
|
@@ -0,0 +1,195 @@
|
|
|
1
|
+
# Quick Proof
|
|
2
|
+
|
|
3
|
+
This is the shortest proof-first path through Scriveno. It is meant for a fresh user who wants to see real shipped artifacts, a demo manuscript, runtime expectations, and the first practical commands before reading the full manual. If your runtime supports Scriveno commands, the executable version of this page is `/scr:first-run`.
|
|
4
|
+
|
|
5
|
+
## What This Proves
|
|
6
|
+
|
|
7
|
+
- Scriveno ships inspectable proof bundles, not only feature claims.
|
|
8
|
+
- Scriveno ships `/scr:first-run` and `scriveno first-run --project .` as guided first-run surfaces.
|
|
9
|
+
- The watchmaker demo includes real manuscript state, drafts, review notes, and a planned next unit.
|
|
10
|
+
- Voice DNA changes output on the same brief, with guided and unguided samples side by side.
|
|
11
|
+
- Runtime behavior is explicit: Claude Code is the primary reference runtime, Codex uses generated `$scr-*` skills, standard slash-command targets use `/scr:*`, and guided targets document their local setup path.
|
|
12
|
+
- The public CLI can audit installed surfaces with `scriveno smoke --json`.
|
|
13
|
+
|
|
14
|
+
## 10-Minute Route
|
|
15
|
+
|
|
16
|
+
### 1. Install
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
npx scriveno@latest
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
For a source checkout while developing Scriveno itself:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
node bin/install.js --runtimes claude-code,cursor,gemini-cli,codex,opencode,copilot,windsurf,antigravity,manus,perplexity-desktop,generic --global --developer --silent
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### 2. Check The Installed Surface
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
scriveno first-run --project .
|
|
32
|
+
scriveno status --project .
|
|
33
|
+
scriveno smoke --json
|
|
34
|
+
scriveno agents --json
|
|
35
|
+
scriveno routes --json
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Expected result: the commands report the recommended first path, installed surfaces, agent prompt availability, route lanes, and any manual gates. They do not mutate manuscript files.
|
|
39
|
+
|
|
40
|
+
### 3. Open The Demo
|
|
41
|
+
|
|
42
|
+
Claude Code:
|
|
43
|
+
|
|
44
|
+
```text
|
|
45
|
+
/scr-first-run
|
|
46
|
+
/scr-demo
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Standard slash-command runtimes:
|
|
50
|
+
|
|
51
|
+
```text
|
|
52
|
+
/scr:first-run
|
|
53
|
+
/scr:demo
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Codex:
|
|
57
|
+
|
|
58
|
+
```text
|
|
59
|
+
$scr-first-run
|
|
60
|
+
$scr-demo
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Then inspect the shipped files:
|
|
64
|
+
|
|
65
|
+
- [data/demo/.manuscript/WORK.md](../data/demo/.manuscript/WORK.md)
|
|
66
|
+
- [data/demo/.manuscript/STYLE-GUIDE.md](../data/demo/.manuscript/STYLE-GUIDE.md)
|
|
67
|
+
- [data/demo/.manuscript/STATE.md](../data/demo/.manuscript/STATE.md)
|
|
68
|
+
- [data/demo/.manuscript/drafts/body/1-the-letter-DRAFT.md](../data/demo/.manuscript/drafts/body/1-the-letter-DRAFT.md)
|
|
69
|
+
- [data/demo/.manuscript/drafts/body/2-the-workshop-DRAFT.md](../data/demo/.manuscript/drafts/body/2-the-workshop-DRAFT.md)
|
|
70
|
+
- [data/demo/.manuscript/reviews/2-the-workshop-REVIEW.md](../data/demo/.manuscript/reviews/2-the-workshop-REVIEW.md)
|
|
71
|
+
- [data/demo/.manuscript/plans/5-the-reunion-PLAN.md](../data/demo/.manuscript/plans/5-the-reunion-PLAN.md)
|
|
72
|
+
|
|
73
|
+
### 4. Read The Proof Bundle
|
|
74
|
+
|
|
75
|
+
Start here:
|
|
76
|
+
|
|
77
|
+
- [data/proof/watchmaker-flow/README.md](../data/proof/watchmaker-flow/README.md)
|
|
78
|
+
- [data/proof/voice-dna/README.md](../data/proof/voice-dna/README.md)
|
|
79
|
+
- [data/proof/creative-context/README.md](../data/proof/creative-context/README.md)
|
|
80
|
+
- [data/proof/first-run/README.md](../data/proof/first-run/README.md)
|
|
81
|
+
- [data/proof/runtime-parity/README.md](../data/proof/runtime-parity/README.md)
|
|
82
|
+
|
|
83
|
+
The fastest comparison is the Voice DNA pair:
|
|
84
|
+
|
|
85
|
+
- [data/proof/voice-dna/UNGUIDED-SAMPLE.md](../data/proof/voice-dna/UNGUIDED-SAMPLE.md)
|
|
86
|
+
- [data/proof/voice-dna/GUIDED-SAMPLE.md](../data/proof/voice-dna/GUIDED-SAMPLE.md)
|
|
87
|
+
|
|
88
|
+
### 5. Ask For The Next Unit
|
|
89
|
+
|
|
90
|
+
The demo includes a planned but undrafted fifth unit. Use the command shape for your host:
|
|
91
|
+
|
|
92
|
+
Claude Code:
|
|
93
|
+
|
|
94
|
+
```text
|
|
95
|
+
/scr-draft 5
|
|
96
|
+
/scr-editor-review 5
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
Standard slash-command runtimes:
|
|
100
|
+
|
|
101
|
+
```text
|
|
102
|
+
/scr:draft 5
|
|
103
|
+
/scr:editor-review 5
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
Codex:
|
|
107
|
+
|
|
108
|
+
```text
|
|
109
|
+
$scr-draft 5
|
|
110
|
+
$scr-editor-review 5
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### 6. Ask Scriveno What To Do Next
|
|
114
|
+
|
|
115
|
+
Claude Code:
|
|
116
|
+
|
|
117
|
+
```text
|
|
118
|
+
/scr-next
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
Standard slash-command runtimes:
|
|
122
|
+
|
|
123
|
+
```text
|
|
124
|
+
/scr:next
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
Codex:
|
|
128
|
+
|
|
129
|
+
```text
|
|
130
|
+
$scr-next
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
Terminal:
|
|
134
|
+
|
|
135
|
+
```bash
|
|
136
|
+
scriveno status --project .
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
## Example Transcript
|
|
140
|
+
|
|
141
|
+
These transcript blocks show the expected shape, not a promise that every host prints identical phrasing.
|
|
142
|
+
|
|
143
|
+
```text
|
|
144
|
+
> /scr-demo
|
|
145
|
+
Created the watchmaker demo project.
|
|
146
|
+
Next: inspect STYLE-GUIDE.md, read the first draft, then run /scr-next.
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
```text
|
|
150
|
+
> scriveno status --project .
|
|
151
|
+
Recommended next command: /scr:next
|
|
152
|
+
Candidate agents: drafter, voice-checker
|
|
153
|
+
Candidate local helpers: scan, save
|
|
154
|
+
Manual gates: writer approval before publishing or overwriting exports
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
```text
|
|
158
|
+
> scriveno first-run --project .
|
|
159
|
+
Scriveno first-run guide
|
|
160
|
+
Current recommendation: /scr:new-work
|
|
161
|
+
Recommended first path:
|
|
162
|
+
1. /scr:demo
|
|
163
|
+
2. cd scriveno-demo
|
|
164
|
+
3. /scr:next
|
|
165
|
+
4. /scr:draft 5
|
|
166
|
+
5. /scr:editor-review 5
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
```text
|
|
170
|
+
> /scr:draft 5
|
|
171
|
+
Loaded STYLE-GUIDE.md and the plan for unit 5.
|
|
172
|
+
Drafted the next atomic unit in fresh context.
|
|
173
|
+
Next: /scr:editor-review 5
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
## Runtime Expectations
|
|
177
|
+
|
|
178
|
+
Use [Runtime Support](runtime-support.md) as the canonical matrix. The short version:
|
|
179
|
+
|
|
180
|
+
- Claude Code is the primary reference runtime.
|
|
181
|
+
- Codex installs generated `$scr-*` skills, mirrored commands, agent prompts, and `.toml` agent metadata.
|
|
182
|
+
- Cursor, Gemini CLI, OpenCode, GitHub Copilot, Windsurf, and Antigravity install command directories plus agent prompts.
|
|
183
|
+
- Manus Desktop and the generic fallback install bundled skill manifests.
|
|
184
|
+
- Perplexity Desktop is a guided local-MCP setup target, not a writable command runtime.
|
|
185
|
+
|
|
186
|
+
No runtime claim here should be read as host-runtime parity proof. The repo proves install surfaces and package artifacts; host parity still needs per-host verification.
|
|
187
|
+
|
|
188
|
+
## Where To Go Next
|
|
189
|
+
|
|
190
|
+
- [Starter Sets](starter-sets.md) for small command paths by writing goal
|
|
191
|
+
- [data/proof/first-run/README.md](../data/proof/first-run/README.md) for committed first-run transcripts
|
|
192
|
+
- [data/proof/runtime-parity/README.md](../data/proof/runtime-parity/README.md) for runtime parity evidence
|
|
193
|
+
- [Getting Started](getting-started.md) for the complete first-project walkthrough
|
|
194
|
+
- [Proof Artifacts](proof-artifacts.md) for the proof hub
|
|
195
|
+
- [Runtime Support](runtime-support.md) for installation and support levels
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
# Release Checklist
|
|
2
|
+
|
|
3
|
+
This checklist is the package-release path for Scriveno maintainers. It is designed to verify the source checkout, the package tarball, the installed runtime surfaces, the published npm package, and the GitHub release.
|
|
4
|
+
|
|
5
|
+
## 1. Confirm A Clean Baseline
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
git status --short --branch
|
|
9
|
+
npm view scriveno version
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Choose the next package version from npm, not from memory.
|
|
13
|
+
|
|
14
|
+
## 2. Run Local Gates
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm run release:check
|
|
18
|
+
npm audit --omit=dev --json
|
|
19
|
+
node bin/install.js routes --json
|
|
20
|
+
node bin/install.js agents --json
|
|
21
|
+
node bin/install.js smoke --json
|
|
22
|
+
node bin/install.js sync --check --json
|
|
23
|
+
git diff --check
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Also scan text files for the repo writing policy:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
node scripts/check-writing-policy.js
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
If that script does not exist in a checkout yet, run the equivalent local policy scan used by the release operator.
|
|
33
|
+
|
|
34
|
+
## 3. Clear Previous Local Installs
|
|
35
|
+
|
|
36
|
+
Before validating a release candidate, clear Scriveno-owned install surfaces so stale files cannot hide installer defects.
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
rm -rf "$HOME/.scriveno"
|
|
40
|
+
rm -rf "$HOME/.codex/commands/scr"
|
|
41
|
+
rm -rf "$HOME/.cursor/commands/scr"
|
|
42
|
+
rm -rf "$HOME/.gemini/commands/scr"
|
|
43
|
+
rm -rf "$HOME/.gemini/antigravity/commands/scr"
|
|
44
|
+
rm -rf "$HOME/.config/opencode/commands/scr"
|
|
45
|
+
rm -rf "$HOME/.github/commands/scr"
|
|
46
|
+
rm -rf "$HOME/.windsurf/commands/scr"
|
|
47
|
+
rm -rf "$HOME/.manus/skills/scriveno"
|
|
48
|
+
npm cache clean --force
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Then reinstall from the checkout:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
npm install -g .
|
|
55
|
+
scriveno --runtimes claude-code,cursor,gemini-cli,codex,opencode,copilot,windsurf,antigravity,manus,perplexity-desktop,generic --global --developer --silent
|
|
56
|
+
scriveno smoke --json
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## 4. Pack The Candidate
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
mkdir -p dist
|
|
63
|
+
npm pack --pack-destination dist
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Inspect the tarball name and confirm the version matches `package.json`.
|
|
67
|
+
|
|
68
|
+
## 5. Commit And Tag
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
git status --short
|
|
72
|
+
git add README.md CHANGELOG.md docs package.json package-lock.json data templates commands .planning test
|
|
73
|
+
git commit -m "Release scriveno X.Y.Z"
|
|
74
|
+
git tag vX.Y.Z
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
Keep the commit message plain and version-specific.
|
|
78
|
+
|
|
79
|
+
## 6. Publish To npm
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
npm publish --access public
|
|
83
|
+
npm view scriveno version
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
The published version must match `package.json` and the tag.
|
|
87
|
+
|
|
88
|
+
## 7. Push Git And Create GitHub Release
|
|
89
|
+
|
|
90
|
+
```bash
|
|
91
|
+
git push origin main
|
|
92
|
+
git push origin vX.Y.Z
|
|
93
|
+
gh release create vX.Y.Z dist/scriveno-X.Y.Z.tgz --title "Scriveno X.Y.Z" --notes-file /tmp/scriveno-release-notes.md
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
The release notes should summarize the user-facing change, docs updated, tests run, and npm verification.
|
|
97
|
+
|
|
98
|
+
## 8. Verify From Published npm
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
npm install -g scriveno@latest
|
|
102
|
+
scriveno --version
|
|
103
|
+
scriveno --runtimes claude-code,cursor,gemini-cli,codex,opencode,copilot,windsurf,antigravity,manus,perplexity-desktop,generic --global --developer --silent
|
|
104
|
+
scriveno smoke --json
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
This is the final proof that a fresh user can install the same package that was released.
|
|
108
|
+
|
|
109
|
+
## 9. Final State
|
|
110
|
+
|
|
111
|
+
```bash
|
|
112
|
+
git status --short --branch
|
|
113
|
+
gh release view vX.Y.Z
|
|
114
|
+
npm view scriveno version
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
The final state should show a clean worktree, a visible GitHub release, and npm latest aligned to the new version.
|
package/docs/release-notes.md
CHANGED
|
@@ -2,6 +2,78 @@
|
|
|
2
2
|
|
|
3
3
|
This document is the public-facing summary of what changed between package releases. For package history, see the root [CHANGELOG](../CHANGELOG.md).
|
|
4
4
|
|
|
5
|
+
## 2.5.0 - 2026-05-16
|
|
6
|
+
|
|
7
|
+
### What changed
|
|
8
|
+
|
|
9
|
+
- Scriveno now ships `/scr:first-run`, an executable first-run path through install checks, demo proof, starter choices, and next commands.
|
|
10
|
+
- The public CLI now supports `scriveno first-run --project .`, giving terminal users the same proof path without relying on host-specific slash-command behavior.
|
|
11
|
+
- First-run guidance is connected to `/scr:help`, `/scr:demo`, Quick Proof, Starter Sets, Runtime Support, Shipped Assets, Command Reference, README launch copy, and architecture docs.
|
|
12
|
+
- Scriveno now includes committed first-run and runtime-parity proof bundles under `data/proof/`.
|
|
13
|
+
- Runtime smoke now validates the 113-command installed surface across Claude Code, Codex, Cursor, Gemini CLI, OpenCode, GitHub Copilot, Windsurf, Antigravity, Manus, Perplexity Desktop, and the generic fallback.
|
|
14
|
+
- README badges, package metadata, constraints metadata, generated config metadata, changelog, release notes, configuration docs, route graph docs, architecture docs, proof docs, and release tests are aligned on `2.5.0`.
|
|
15
|
+
|
|
16
|
+
### Why it matters
|
|
17
|
+
|
|
18
|
+
The previous release documented a stronger proof path. This release makes that path executable. A new writer can install Scriveno, run one first-run command, inspect proof artifacts, create the demo, and move into drafting without having to assemble the path from documentation.
|
|
19
|
+
|
|
20
|
+
### Affected areas
|
|
21
|
+
|
|
22
|
+
- first-run command surface
|
|
23
|
+
- public CLI installer and smoke checks
|
|
24
|
+
- proof artifact bundles
|
|
25
|
+
- README badges and launch copy
|
|
26
|
+
- runtime support matrix
|
|
27
|
+
- command reference and route graph docs
|
|
28
|
+
- package metadata and generated project examples
|
|
29
|
+
- release-alignment tests
|
|
30
|
+
|
|
31
|
+
### Verification
|
|
32
|
+
|
|
33
|
+
- `npm run policy:check`
|
|
34
|
+
- `node --test test/first-run-proof-surface.test.js test/adaptive-concierge.test.js test/auto-invoke-engine.test.js test/command-surface-coherence.test.js test/collaboration-trust-surface.test.js test/package.test.js test/phase15-proof-artifacts-positioning.test.js`
|
|
35
|
+
- `npm test`
|
|
36
|
+
- `npm run release:check`
|
|
37
|
+
- `git diff --check`
|
|
38
|
+
- `scriveno first-run --project .`
|
|
39
|
+
- `scriveno smoke --json`
|
|
40
|
+
|
|
41
|
+
## 2.0.12 - 2026-05-16
|
|
42
|
+
|
|
43
|
+
### What changed
|
|
44
|
+
|
|
45
|
+
- Scriveno now ships [Quick Proof](quick-proof.md), a 10-minute route through install checks, the watchmaker demo, Voice DNA samples, runtime command shapes, and the next draft command.
|
|
46
|
+
- Scriveno now ships [Starter Sets](starter-sets.md), goal-based command paths for drafting, polishing, publishing, translation, sacred commentary, and repair.
|
|
47
|
+
- Scriveno now ships [Release Checklist](release-checklist.md), a maintainer path for local gates, stale install cleanup, packing, npm publishing, GitHub release creation, and fresh `scriveno@latest` verification.
|
|
48
|
+
- `npm run release:check` now includes `npm run policy:check`, which scans tracked text files for the repository writing policy before packaging.
|
|
49
|
+
- README badges, Getting Started, Proof Artifacts, Runtime Support, Development, Contributing, Testing, Shipped Assets, Route Graph, Configuration, changelog, package metadata, constraints metadata, generated config metadata, and release tests are aligned on `2.0.12`.
|
|
50
|
+
|
|
51
|
+
### Why it matters
|
|
52
|
+
|
|
53
|
+
The product already had proof artifacts, but the shortest path through them was too implicit. This release makes the first 10 minutes clearer for a new writer and makes the release process harder to drift by documenting and testing the local, npm, GitHub, and fresh-install verification path.
|
|
54
|
+
|
|
55
|
+
### Affected areas
|
|
56
|
+
|
|
57
|
+
- README badges and launch copy
|
|
58
|
+
- proof-first documentation
|
|
59
|
+
- starter command guidance
|
|
60
|
+
- release checklist and testing docs
|
|
61
|
+
- writing-policy release gate
|
|
62
|
+
- package metadata and generated project examples
|
|
63
|
+
- planning state and release-alignment tests
|
|
64
|
+
|
|
65
|
+
### Verification
|
|
66
|
+
|
|
67
|
+
- `node --test test/first-run-proof-surface.test.js test/package.test.js test/phase16-trust-regression.test.js test/phase14-runtime-credibility.test.js`
|
|
68
|
+
- `npm run policy:check`
|
|
69
|
+
- `npm run release:check`
|
|
70
|
+
- `node bin/install.js routes --json`
|
|
71
|
+
- `node bin/install.js agents --json`
|
|
72
|
+
- `node bin/install.js sync --check --json`
|
|
73
|
+
- `node bin/install.js smoke --json`
|
|
74
|
+
- `npm audit --omit=dev --json`
|
|
75
|
+
- `git diff --check`
|
|
76
|
+
|
|
5
77
|
## 2.0.11 - 2026-05-16
|
|
6
78
|
|
|
7
79
|
### What changed
|
package/docs/route-graph.md
CHANGED
|
@@ -13,9 +13,9 @@ The text report summarizes command count, graph edges, agent-capable routes, loc
|
|
|
13
13
|
|
|
14
14
|
## Current Shape
|
|
15
15
|
|
|
16
|
-
As of `2.0
|
|
16
|
+
As of `2.5.0`, the route graph contains:
|
|
17
17
|
|
|
18
|
-
-
|
|
18
|
+
- 113 commands
|
|
19
19
|
- intent-order edges from `command_intents`
|
|
20
20
|
- dependency-chain edges from `dependencies.core_chain`
|
|
21
21
|
- automation lanes from `getCommandAutomationPolicy()`
|
package/docs/runtime-support.md
CHANGED
|
@@ -65,6 +65,18 @@ Node is not a runtime dependency for Scriveno's markdown command system itself.
|
|
|
65
65
|
- Manus Desktop and the generic skills fallback install a manifest `SKILL.md`, mirrored command files, and agent prompts inside the skill bundle.
|
|
66
66
|
- Perplexity Desktop receives setup assets for a local-MCP connector. It does not receive writable command or agent prompt directories from the installer.
|
|
67
67
|
|
|
68
|
+
## First-Run Command Shapes
|
|
69
|
+
|
|
70
|
+
Scriveno docs use `/scr:*` as the shared command id format unless a host-specific example is needed. Installed command surfaces differ by runtime:
|
|
71
|
+
|
|
72
|
+
- Claude Code: `/scr-first-run`, `/scr-demo`, `/scr-new-work`, `/scr-next`
|
|
73
|
+
- Standard command-directory runtimes: `/scr:first-run`, `/scr:demo`, `/scr:new-work`, `/scr:next`
|
|
74
|
+
- Codex: `$scr-first-run`, `$scr-demo`, `$scr-new-work`, `$scr-next`
|
|
75
|
+
- Guided targets: follow the generated setup instructions and connector recipe
|
|
76
|
+
|
|
77
|
+
Use [Quick Proof](quick-proof.md) for the 10-minute proof route and [Starter Sets](starter-sets.md) for goal-based command paths.
|
|
78
|
+
Use [Runtime Parity Evidence](../data/proof/runtime-parity/README.md) for the committed boundary between install-surface proof and host-runtime parity proof.
|
|
79
|
+
|
|
68
80
|
## Shared Auto-Invoke Engine
|
|
69
81
|
|
|
70
82
|
Every install target receives the same read-only status engine through Scriveno's shared asset directory:
|
|
@@ -126,5 +138,7 @@ That distinction is intentional. Installer-path coverage and guided setup assets
|
|
|
126
138
|
## See Also
|
|
127
139
|
|
|
128
140
|
- [Getting Started](getting-started.md) -- install flow and first-run expectations
|
|
141
|
+
- [Quick Proof](quick-proof.md) -- first-run proof path and runtime command shapes
|
|
142
|
+
- [Starter Sets](starter-sets.md) -- small command sets by writing goal
|
|
129
143
|
- [Shipped Assets](shipped-assets.md) -- trust-critical files that ship with the package
|
|
130
144
|
- [Release Notes](release-notes.md) -- latest package-level summary
|
package/docs/sacred-texts.md
CHANGED
|
@@ -292,5 +292,5 @@ Here is a quick walkthrough for starting a sacred writing project:
|
|
|
292
292
|
## See Also
|
|
293
293
|
|
|
294
294
|
- [Getting Started](getting-started.md) -- Install Scriveno and create your first project
|
|
295
|
-
- [Command Reference](command-reference.md) -- Full reference for all
|
|
295
|
+
- [Command Reference](command-reference.md) -- Full reference for all 113 commands, including the [Sacred Exclusive](command-reference.md#sacred-exclusive) section
|
|
296
296
|
- [README](../README.md) -- Project overview and feature list
|
package/docs/shipped-assets.md
CHANGED
|
@@ -115,11 +115,16 @@ Sacred commands read top-level sacred profile keys in new projects and preserve
|
|
|
115
115
|
- `CHANGELOG.md` -- package-level release history
|
|
116
116
|
- `docs/release-notes.md` -- public-facing release summary
|
|
117
117
|
- `docs/proof-artifacts.md` -- canonical proof hub for sample-flow and voice-preservation evidence
|
|
118
|
+
- `docs/quick-proof.md` -- proof-first first-run route through install checks, demo inspection, and next-draft commands
|
|
119
|
+
- `docs/starter-sets.md` -- small command paths for common writing goals
|
|
120
|
+
- `docs/release-checklist.md` -- release validation path for source, npm, GitHub, and fresh installs
|
|
118
121
|
- `docs/runtime-support.md` -- canonical runtime matrix, Node baseline, and support-confidence framing
|
|
119
122
|
- `docs/command-reference.md` -- canonical command surface reference
|
|
120
123
|
- `docs/configuration.md` -- canonical project config and package metadata reference
|
|
121
124
|
- `data/proof/watchmaker-flow/README.md` -- canonical sample-flow proof bundle rooted in shipped demo files
|
|
122
125
|
- `data/proof/voice-dna/README.md` -- canonical Voice DNA proof bundle
|
|
126
|
+
- `data/proof/first-run/README.md` -- committed transcript artifact for the executable first-run path
|
|
127
|
+
- `data/proof/runtime-parity/README.md` -- runtime install-surface evidence and host-parity boundary
|
|
123
128
|
- `commands/scr/export.md` -- source of truth for export command behavior
|
|
124
129
|
- `docs/publishing.md` -- user-facing explanation of export formats and publishing packages
|
|
125
130
|
- `docs/contributing.md` -- contributor-facing guidance for extending export support
|