@lacodda/rigger 0.25.0 → 0.27.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.
Files changed (3) hide show
  1. package/README.md +54 -131
  2. package/package.json +2 -2
  3. package/run.js +24 -1
package/README.md CHANGED
@@ -11,39 +11,24 @@
11
11
 
12
12
  ## Why
13
13
 
14
- Run more than a handful of projects and the record of them scatters: a plan in one file, a changelog in another, a session log the assistant writes for itself, a release calendar kept by hand. Three symptoms follow. You stop reading the record, because it is prose and prose cannot be filtered or summed up across projects. The assistant reads it every session at full price, and the biggest project no longer fits in a context window at all. And the facts about what actually shipped live in git, where nobody looks.
14
+ Run more than a handful of projects and the record of them scatters: a plan in one file, a changelog in another, a session log the assistant writes for itself, a release calendar kept by hand. You stop reading it, because prose cannot be filtered or summed up across projects. The assistant reads it every session at full price. And what actually shipped lives in git, where nobody looks.
15
15
 
16
- rigger keeps the record as data, in a local SQLite file, and derives everything else from it: the five-line digest you read, the context packet the assistant starts from, the calendar of what ships when, and the queue of decisions waiting for you.
16
+ rigger keeps the record as data, in one local SQLite file, and derives the rest from it: the packet an assistant starts from, the questions waiting for you, the calendar of what ships when - with git, not the plan, deciding what shipped.
17
17
 
18
- ## A first look
18
+ ## A day with rigger
19
19
 
20
- ```console
21
- $ rigger init
22
- Created C:\Users\you\AppData\Local\lacodda\rigger\data\rigger.db (schema version 4)
23
- Next: rigger project add <path>
20
+ Plan a stage, and write down what was decided and what only you can answer:
24
21
 
25
- $ rigger project add C:\dev\sample
26
- Recorded 'sample' at C:\dev\sample
27
- remote: https://github.com/acme/sample.git
22
+ ```console
23
+ $ rigger version add sample v0.1.0 --title "First light" --task "read a sheet" --task "write the report" --week 2026-W43
24
+ Added v0.1.0 to sample, with 2 tasks
25
+ aimed at 2026-W43 - the week of 2026-10-23
28
26
 
29
- $ rigger import sample --hub C:\dev\sample\hub
30
- sample:
31
- versions 3 added, 0 updated
32
- tasks 2 added, 0 updated
33
- decisions 1 added
34
- questions 1 added
35
-
36
- $ rigger doctor
37
- database: C:\Users\you\AppData\Local\lacodda\rigger\data\rigger.db
38
- schema: version 4
39
- projects: 1
40
- versions: 3
41
- tasks: 2
42
- sessions: 0
43
- events: 2
27
+ $ rigger note sample "Which file formats come first?" --kind question
28
+ Asked the owner about sample; it waits in the inbox until answered
44
29
  ```
45
30
 
46
- Years of notes arrive in one command, and running it again is quiet. Then a session starts from the packet rather than from the notes:
31
+ A session starts from the packet - a few hundred tokens, whatever the size of the history behind it - rather than from the notes:
47
32
 
48
33
  ```console
49
34
  $ rigger context sample
@@ -51,140 +36,78 @@ $ rigger context sample
51
36
 
52
37
  C:\dev\sample
53
38
  https://github.com/acme/sample.git
54
- Last shipped: v0.2.0 on 2026-09-03
55
- 1 versions planned, 2 tasks open
39
+ Nothing shipped yet
40
+ 2 versions planned, 3 tasks open
56
41
 
57
- ## Current stage: v0.3.0 · Search
58
- - full-text index
59
- - a query language
42
+ ## Current stage: v0.1.0 · First light
43
+ - read a sheet
44
+ - write the report
60
45
 
61
46
  ## Waiting for the owner
62
- - [2] Pick the release day.
47
+ - [2] Which file formats come first?
63
48
 
64
49
  ## Recent
65
- - 2026-09-03 · decision · The record is the database — Prose cannot be filtered.
66
-
67
- ## Next step
68
- Ship the importer next.
69
- ```
70
-
71
- That packet costs 96 tokens here and holds a 3000-token budget on a project with years of history - against tens of thousands for reading the notes it came from, which past a certain size no longer fit at all.
72
-
73
- One command hands it to your assistant and starts the session in the project:
74
-
75
- ```console
76
- $ rigger open sample
77
- Starting claude in C:\dev\sample with the packet for sample
78
- ```
79
-
80
- The MCP server is how the assistant reads that packet and writes back to the record as it works - decisions, findings and pitfalls become events, not lines in a transcript nobody opens again. The installer registers it, along with the hook that closes a sitting when the assistant stops:
81
-
82
- ```console
83
- $ irm https://raw.githubusercontent.com/lacodda/rigger/main/tools/install.ps1 | iex
84
- ...
85
- Registered the rigger MCP server with claude.
86
- Added the Stop hook: a sitting now closes itself.
50
+ - 2026-10-07 · decision · Read sheets with one library, not two
87
51
  ```
88
52
 
89
- And for you, rather than for the assistant, the project's own screen - what it is, where it stands, what it has written down:
53
+ Through the [MCP server](https://lacodda.github.io/rigger/reference/mcp/) the assistant writes back as it works - decisions, findings, the next step. A tag is the proof a version shipped, and the commits since are the changelog:
90
54
 
91
55
  ```console
92
- $ rigger show sample
93
- sample
94
- A sample product
95
-
96
- path C:\dev\sample
97
- gate cargo fmt --all --check && cargo clippy --all-targets -- -D warnings && cargo test
98
-
99
- Last shipped v0.2.0 on 2026-09-03, 2 commits since
100
- 1 versions planned, 2 tasks open
101
-
102
- Current stage: v0.3.0 · Search
103
- > full-text index
104
- a query language
105
-
106
- Written down:
107
- vision Vision of sample 2026-09-12 rigger doc show sample vision
108
-
109
- Next step
110
- Ship the importer next.
111
- ```
112
-
113
- What actually shipped is not taken on trust. `sync` reads the repository's tags and commits in-process and writes what they prove; where the plan says a version shipped and no tag agrees, the disagreement is reported rather than corrected:
114
-
115
- ```console
116
- $ rigger sync claimed
117
- claimed:
118
- shipped v0.1.0 on 2026-09-04
56
+ $ rigger sync sample
57
+ sample:
58
+ shipped v0.1.0 on 2026-10-07
119
59
  read 2 changes from commit messages
120
- no tag v0.2.0 is closed in the plan
121
- ```
122
60
 
123
- Those changes come out of the commit messages themselves - `feat`, `fix` and anything breaking, dated by the commit rather than by the sync - so the chronicle stays current whether or not anyone opens a session.
61
+ $ rigger session end sample
62
+ Session on sample closed, open since 2026-10-07T13:14:59Z.
124
63
 
125
- Once there is a record, it answers questions - which is the point of keeping it as data:
64
+ recorded 1 finding
65
+ closed 2 tasks
66
+ next: Start the charts from the report's table
67
+ copied the database to C:\Users\you\AppData\Local\lacodda\rigger\data\profiles\line\rigger.v27-20261007-131500.bak
126
68
 
127
- ```console
128
- $ rigger find budget
129
- sample 2026-09-04 decision The budget is a gate, not a suggestion.
130
- sample 2026-09-04 pitfall A wide window hides what the budget dropped.
131
-
132
- $ rigger why sample v0.3.0
133
- v0.3.0 — shipped 2026-09-04
134
- the work after v0.2.0 (2026-09-04)
135
-
136
- 2026-09-04 decision The budget is a gate, not a suggestion.
137
- 2026-09-04 pitfall A wide window hides what the budget dropped.
138
- 2026-09-04 change feat: rank what a person wrote above a commit
69
+ Write it into a diary with: rigger session end sample --diary <file>
139
70
  ```
140
71
 
141
- And it answers the question the notes never could - what is waiting on you, across everything at once:
72
+ And the record answers what the notes never could - what waits on you across every project, where a thing was decided, what went into a release:
142
73
 
143
74
  ```console
144
75
  $ rigger inbox
145
- 6 questions in 3 projects
76
+ 1 question in 1 project
146
77
 
147
- alpha [ 1] 2026-09-04 Place in the release calendar
148
- [ 2] 2026-09-04 Sign the binaries?
149
- beta [ 3] 2026-09-04 Place in the release calendar
78
+ sample [ 2] 2026-10-07 Which file formats come first?
150
79
 
151
- Asked by several projects - one answer settles each group:
152
- Place in the release calendar — alpha, beta, gamma
153
- ```
80
+ Answer one with: rigger resolve <project> <id> "<answer>"
154
81
 
155
- And it lays the releases out over the weeks, comparing what you aimed at with what the tags say happened:
82
+ $ rigger resolve sample 2 "CSV and XLSX; ODS later"
83
+ Answered [2]: Which file formats come first?
84
+ the answer is recorded as a decision
156
85
 
157
- ```console
158
- $ rigger calendar --from 2026-W37 --weeks 5
159
- 2026-W37 2026-W38 2026-W39 2026-W40 2026-W41
160
- sample *v0.1.0 >v0.2.0 ·v0.3.0 A
161
- widget +v0.1.0 ·v0.2.0 B
162
-
163
- + shipped as planned > slipped ! overdue * unplanned · planned
86
+ $ rigger why sample v0.1.0
87
+ v0.1.0 · First light — shipped 2026-10-07
88
+ the work from the start of the record
164
89
 
165
- sample v0.2.0 — aimed at 2026-W37, 2 weeks late
90
+ 2026-10-07 decision Read sheets with one library, not two
91
+ 2026-10-07 answered Which file formats come first?
92
+ 2026-10-07 finding A merged cell is read as its first cell
93
+ 2026-10-07 change feat: read a sheet
94
+ 2026-10-07 change feat: write the report
166
95
  ```
167
96
 
168
- A project is named after its directory - the name you call it by, not the one its manifest publishes under - and `--name` overrides. Every command that shows facts also prints them with `--json`.
97
+ The whole first week, command by command: [Your first week](https://lacodda.github.io/rigger/guides/first-week/).
169
98
 
170
99
  ## What you get
171
100
 
172
- - **Projects, versions, tasks, sessions.** A project has a map of versions; a version is a stage that ends in a tag; a task is a unit of work inside a version (at home) or a ticket across several projects and branches (at work).
173
- - **Facts from git.** A pushed tag means the version shipped, on that date. Commits since the last tag are activity. The plan cannot claim more than git confirms.
174
- - **An MCP server as the assistant's only pen.** Decisions, findings, pitfalls, changes and the next step are recorded as events through tools, not by editing markdown.
175
- - **The owner's inbox and a release calendar**, both derived from the same record rather than kept by hand.
176
- - **Hubs as an export.** The markdown files you keep in Obsidian are generated from the database, not written by hand.
177
- - **Thin project skills.** The file an assistant reads first is one template filled from the record.
101
+ - **Projects, versions, tasks, sessions.** A version is a stage that ends in a tag; a task is work inside it - or, at work, a ticket across several repositories and branches.
102
+ - **Facts from git.** A tag means the version shipped, on that date; the plan cannot claim more than git confirms, and `doctor` names where they part.
103
+ - **An MCP server as the assistant's only pen**, and a context packet held to a token budget.
104
+ - **Your inbox, a weekly brief and a release calendar**, derived from the same record rather than kept by hand.
105
+ - **`--json` on every command**, each field held by a test to its reference page.
106
+ - **Hubs as an export.** Markdown notes are written from the record, and a hand-kept hub [moves into it](https://lacodda.github.io/rigger/guides/from-a-hub/) in one command.
178
107
 
179
108
  ## Status
180
109
 
181
- The record, the context packet, the MCP server, facts from git, the owner's
182
- inbox, the release calendar and thin project skills are in daily use across
183
- the whole line. The rules a line and a project state about themselves, and
184
- the gate a project runs, are documents in the record rather than pasted into
185
- every project's skill.
186
-
187
- Released versions and what landed in each: [CHANGELOG](https://github.com/lacodda/rigger/blob/main/CHANGELOG.md).
110
+ In daily use across a line of eighteen products: the record, the packet, the MCP server, facts from git, the owner's screens, task cards at work, and a JSON contract for every command ahead of 1.0. Released versions and what landed in each: [CHANGELOG](https://github.com/lacodda/rigger/blob/main/CHANGELOG.md).
188
111
 
189
112
  ## Install
190
113
 
@@ -201,11 +124,11 @@ npm i -g @lacodda/rigger
201
124
  cargo install rigger
202
125
  ```
203
126
 
204
- Every installer also leaves `rgr` beside `rigger` - the same program under a shorter name, as a link rather than a second copy, so it cannot fall behind. It is skipped when `rgr` already means something else on your machine, and `RIGGER_NO_ALIAS=1` turns it off. `cargo install` produces `rigger` only.
127
+ Every installer also leaves `rgr` beside `rigger` - the same program under a shorter name, as a link rather than a second copy. It is skipped when `rgr` already means something else on your machine, and `RIGGER_NO_ALIAS=1` turns it off. `cargo install` produces `rigger` only.
205
128
 
206
129
  ## Documentation
207
130
 
208
- https://lacodda.github.io/rigger/ - getting started, concepts, and a reference page per command. Architecture decisions live in https://github.com/lacodda/rigger/tree/main/docs/adr.
131
+ https://lacodda.github.io/rigger/ - getting started, guides, concepts, and a reference page per command. Architecture decisions live in https://github.com/lacodda/rigger/tree/main/docs/adr.
209
132
 
210
133
  ## License
211
134
 
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "name": "@lacodda/rigger",
3
- "version": "0.25.0",
3
+ "version": "0.27.0",
4
4
  "rigger": {
5
- "binary": "v0.25.0"
5
+ "binary": "v0.27.0"
6
6
  },
7
7
  "description": "One seat for all your projects and tasks: a local record of what is done, what is next and when it ships - read by you and your coding assistant",
8
8
  "license": "MIT",
package/run.js CHANGED
@@ -2,12 +2,35 @@
2
2
  // Thin launcher: forwards everything to the rigger binary, downloading it on
3
3
  // first run when the postinstall script was skipped (npm v12 default).
4
4
  const fs = require("fs");
5
+ const os = require("os");
5
6
  const { spawnSync } = require("child_process");
6
7
  const { install, exePath } = require("./download");
7
8
 
9
+ // The keystrokes a terminal sends to every process on it, this launcher
10
+ // included. Left to the default, the launcher would die at once and hand the
11
+ // prompt back while rigger - a gate it is running, an editor it opened - is
12
+ // still deciding what to do with the same keystroke. Listening keeps the
13
+ // launcher alive until the binary is done; the binary alone decides.
14
+ const KEYSTROKES =
15
+ process.platform === "win32" ? ["SIGINT", "SIGBREAK"] : ["SIGINT", "SIGQUIT"];
16
+
8
17
  function exec() {
18
+ const stayPut = () => {};
19
+ for (const signal of KEYSTROKES) process.on(signal, stayPut);
20
+
9
21
  const result = spawnSync(exePath, process.argv.slice(2), { stdio: "inherit" });
10
- process.exit(result.status === null ? 1 : result.status);
22
+ if (result.error) {
23
+ console.error(`@lacodda/rigger: cannot start ${exePath}: ${result.error.message}`);
24
+ process.exit(1);
25
+ }
26
+ if (result.signal) {
27
+ // Ended by a signal: end the same way, so the shell reports it as it
28
+ // would for the binary run directly (130 after Ctrl+C), not as a plain 1.
29
+ for (const signal of KEYSTROKES) process.removeListener(signal, stayPut);
30
+ process.kill(process.pid, result.signal);
31
+ process.exit(128 + (os.constants.signals[result.signal] || 0));
32
+ }
33
+ process.exit(result.status);
11
34
  }
12
35
 
13
36
  if (fs.existsSync(exePath)) {