memento-mori-jester 0.1.46 → 0.1.47

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/CHANGELOG.md CHANGED
@@ -4,6 +4,12 @@ All notable changes to Memento Mori Jester are tracked here.
4
4
 
5
5
  ## Unreleased
6
6
 
7
+ ## 0.1.47
8
+
9
+ - Reworked the README Start Here section into a clearer four-step path: try without writing files, add a recommended preset, connect an agent, then add hooks or CI.
10
+ - Updated Getting Started to mirror the same onboarding order and mention playground sample buttons.
11
+ - Kept this as a docs-only onboarding release; no CLI, MCP, config, review, playground runtime, or release workflow behavior changed.
12
+
7
13
  ## 0.1.46
8
14
 
9
15
  - Added one-click sample buttons to the local playground for command, plan, diff, and final-answer reviews.
package/README.md CHANGED
@@ -16,7 +16,7 @@ See the full [demo transcript](docs/DEMO.md).
16
16
 
17
17
  ## Start Here
18
18
 
19
- No install needed:
19
+ ### 1. Try It Without Writing Files
20
20
 
21
21
  ```powershell
22
22
  npx -y memento-mori-jester@latest start
@@ -25,11 +25,13 @@ npx -y memento-mori-jester@latest command "git reset --hard"
25
25
  npx -y memento-mori-jester@latest playground
26
26
  ```
27
27
 
28
- Add it to a project:
28
+ `start` prints the guided checklist. `playground` opens the local browser UI with sample buttons for commands, plans, diffs, and final answers.
29
+
30
+ ### 2. Add It To A Project
29
31
 
30
32
  ```powershell
31
33
  npx -y memento-mori-jester@latest config recommend
32
- npx -y memento-mori-jester@latest bootstrap --preset node
34
+ npx -y memento-mori-jester@latest bootstrap --preset <recommended-preset>
33
35
  ```
34
36
 
35
37
  That writes:
@@ -38,6 +40,25 @@ That writes:
38
40
  - `memento-mori.mcp.json`
39
41
  - `MEMENTO_MORI.md`
40
42
 
43
+ Common presets are `node`, `python`, `web`, `api`, `infra`, `ai`, and `security`.
44
+
45
+ ### 3. Connect Your Agent
46
+
47
+ ```powershell
48
+ npx -y memento-mori-jester@latest setup
49
+ npx -y memento-mori-jester@latest setup --agent codex
50
+ npx -y memento-mori-jester@latest setup --agent claude
51
+ ```
52
+
53
+ Use the generated MCP snippet and agent instruction in Codex, Claude Code, or another MCP-capable client.
54
+
55
+ ### 4. Add Hooks Or CI When Ready
56
+
57
+ ```powershell
58
+ npx -y memento-mori-jester@latest bootstrap --preset <recommended-preset> --hook pre-commit
59
+ npx -y memento-mori-jester@latest bootstrap --preset <recommended-preset> --hook pre-commit --hook pre-push
60
+ ```
61
+
41
62
  Add it to GitHub code scanning:
42
63
 
43
64
  ```powershell
package/ROADMAP.md CHANGED
@@ -6,6 +6,7 @@ Memento Mori Jester is usable today as a CLI, MCP server, GitHub Action, and git
6
6
 
7
7
  ## Recently Shipped
8
8
 
9
+ - README onboarding polish in v0.1.47 around the shortest path from `npx` to playground, agent setup, hooks, and CI.
9
10
  - Playground sample buttons in v0.1.46 for trying command, plan, diff, and final-answer reviews from the first screen.
10
11
  - Fixture curation pass in v0.1.45 that moved all built-in and structural rule evidence to medium-or-better confidence.
11
12
  - Additional precision pass for fixture-driven tuning signals (scoped to high-signal rule families first).
@@ -35,7 +36,7 @@ Memento Mori Jester is usable today as a CLI, MCP server, GitHub Action, and git
35
36
 
36
37
  ## Product Ideas
37
38
 
38
- - Polish README onboarding around the shortest path from `npx` to playground, agent setup, and hooks.
39
+ - Add first-run screenshots or a short hosted demo clip once the README path has had real-user feedback.
39
40
 
40
41
  ## Quality And Safety
41
42
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  This is the shortest path for a normal project.
4
4
 
5
- ## 1. Check It Runs
5
+ ## 1. Try It Without Writing Files
6
6
 
7
7
  For a guided checklist:
8
8
 
@@ -18,8 +18,6 @@ npx -y memento-mori-jester@latest doctor
18
18
 
19
19
  You should see four `PASS` lines.
20
20
 
21
- ## 2. See The Point
22
-
23
21
  ```powershell
24
22
  npx -y memento-mori-jester@latest command "git reset --hard"
25
23
  ```
@@ -38,19 +36,21 @@ For the local browser version:
38
36
  npx -y memento-mori-jester@latest playground
39
37
  ```
40
38
 
39
+ The playground starts on `127.0.0.1` and includes sample buttons for command, plan, diff, and final-answer reviews.
40
+
41
41
  If a rule feels noisy, ask for tuning advice before disabling it:
42
42
 
43
43
  ```powershell
44
44
  npx -y memento-mori-jester@latest tune risky-domain
45
45
  ```
46
46
 
47
- ## 3. Add It To A Project
47
+ ## 2. Add It To A Project
48
48
 
49
49
  Run this from the folder of the project you want protected:
50
50
 
51
51
  ```powershell
52
52
  npx -y memento-mori-jester@latest config recommend
53
- npx -y memento-mori-jester@latest bootstrap --preset node
53
+ npx -y memento-mori-jester@latest bootstrap --preset <recommended-preset>
54
54
  ```
55
55
 
56
56
  Use `--preset ai` for LLM, MCP, and agent apps, `--preset api` for backend APIs, `--preset web` for frontend/browser apps, `--preset infra` for deployment or cloud infrastructure repos, or `--preset security` for a stricter general policy.
@@ -65,32 +65,34 @@ That creates:
65
65
 
66
66
  Existing files are kept. Add `--force` only when you want to overwrite the starter files.
67
67
 
68
- ## 4. Optional Git Hooks
68
+ ## 3. Agent Instruction
69
69
 
70
- To make git call the Jester before commits:
70
+ For exact Codex, Claude Code, or generic MCP snippets:
71
71
 
72
72
  ```powershell
73
- npx -y memento-mori-jester@latest bootstrap --preset node --hook pre-commit
73
+ npx -y memento-mori-jester@latest setup
74
+ npx -y memento-mori-jester@latest setup --agent codex
75
+ npx -y memento-mori-jester@latest setup --agent claude
74
76
  ```
75
77
 
76
- To also check before pushing:
78
+ Put this in your agent rules or custom instructions:
77
79
 
78
- ```powershell
79
- npx -y memento-mori-jester@latest bootstrap --preset node --hook pre-commit --hook pre-push
80
+ ```text
81
+ Before risky commands, final answers, commits, or large edits, call the Memento Mori Jester. Treat BLOCK as requiring a changed plan, and CAUTION as requiring at least one concrete verification step.
80
82
  ```
81
83
 
82
- ## 5. Agent Instruction
84
+ ## 4. Optional Git Hooks
83
85
 
84
- For exact Codex, Claude Code, or generic MCP snippets:
86
+ To make git call the Jester before commits:
85
87
 
86
88
  ```powershell
87
- npx -y memento-mori-jester@latest setup
89
+ npx -y memento-mori-jester@latest bootstrap --preset <recommended-preset> --hook pre-commit
88
90
  ```
89
91
 
90
- Put this in your agent rules or custom instructions:
92
+ To also check before pushing:
91
93
 
92
- ```text
93
- Before risky commands, final answers, commits, or large edits, call the Memento Mori Jester. Treat BLOCK as requiring a changed plan, and CAUTION as requiring at least one concrete verification step.
94
+ ```powershell
95
+ npx -y memento-mori-jester@latest bootstrap --preset <recommended-preset> --hook pre-commit --hook pre-push
94
96
  ```
95
97
 
96
98
  ## What To Share With Someone Else
@@ -0,0 +1,25 @@
1
+ # v0.1.47 Release Notes
2
+
3
+ This is a docs-only onboarding release. It makes the first README path clearer without changing CLI behavior, review behavior, MCP tools, config, playground runtime, GitHub Actions, or release automation.
4
+
5
+ ## Changed
6
+
7
+ - Reworked README Start Here into four steps:
8
+ - try Jester without writing files,
9
+ - add it to a project with the recommended preset,
10
+ - connect Codex, Claude Code, or a generic MCP client,
11
+ - add hooks or GitHub code scanning when ready.
12
+ - Updated Getting Started to follow the same order and mention the playground sample buttons.
13
+ - Updated the roadmap with the shipped README polish and the next demo/onboarding idea.
14
+
15
+ ## Release Validation
16
+
17
+ ```powershell
18
+ npm.cmd test
19
+ npm.cmd run demo:svg:check
20
+ npm.cmd run pack:dry
21
+ git diff --check
22
+ node .\dist\cli.js start
23
+ node .\dist\cli.js config recommend
24
+ git diff | node .\dist\cli.js diff --fail-on block --subject "v0.1.47 README onboarding polish"
25
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "memento-mori-jester",
3
- "version": "0.1.46",
3
+ "version": "0.1.47",
4
4
  "description": "A local court-jester sidecar for AI coding agents: review plans, commands, diffs, and final claims before they get too pleased with themselves.",
5
5
  "type": "module",
6
6
  "repository": {