samagotchi 0.106.0 → 0.108.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +157 -1
- data/bin/chi +2 -0
- data/docs/architecture.md +6 -1
- data/docs/cli.md +45 -5
- data/docs/guardrails.md +8 -2
- data/docs/internals/engine.md +17 -6
- data/docs/internals/participants.md +129 -30
- data/docs/internals/remote-sessions.md +12 -5
- data/docs/internals/working-set.md +2 -1
- data/docs/memory.md +20 -0
- data/docs/plugins.md +38 -3
- data/docs/releasing.md +13 -6
- data/docs/sessions.md +39 -4
- data/docs/sub-agent.md +3 -1
- data/docs/testing.md +7 -1
- data/lib/samagotchi/bridge/turn_accumulator.rb +8 -1
- data/lib/samagotchi/bridge.rb +7 -2
- data/lib/samagotchi/bridge_client/stream_request.rb +10 -3
- data/lib/samagotchi/bundles/coordinator/manifest.yml +6 -5
- data/lib/samagotchi/bundles/coordinator/plugin.rb +85 -5
- data/lib/samagotchi/bundles/coordinator/skill_coordinator.md +18 -0
- data/lib/samagotchi/bundles/cost-cap/manifest.yml +2 -2
- data/lib/samagotchi/bundles/cost-cap/plugin.rb +51 -9
- data/lib/samagotchi/bundles/dev/manifest.yml +2 -2
- data/lib/samagotchi/bundles/system/manifest.yml +2 -2
- data/lib/samagotchi/bundles/system/memory_guide.md +1 -1
- data/lib/samagotchi/bundles/work-cap/manifest.yml +2 -2
- data/lib/samagotchi/bundles/work-cap/plugin.rb +50 -14
- data/lib/samagotchi/child_reports.rb +2 -1
- data/lib/samagotchi/cli/parent_wait.rb +1 -1
- data/lib/samagotchi/context_sources.rb +1 -6
- data/lib/samagotchi/continue_offer.rb +56 -7
- data/lib/samagotchi/engine.rb +36 -25
- data/lib/samagotchi/guardrail_wiring.rb +9 -6
- data/lib/samagotchi/guardrails/review_boundary.rb +6 -57
- data/lib/samagotchi/guardrails/review_paths.rb +93 -0
- data/lib/samagotchi/idle_scheduler.rb +17 -2
- data/lib/samagotchi/last_turn.rb +7 -0
- data/lib/samagotchi/log_subscriber.rb +2 -1
- data/lib/samagotchi/memory_orphans.rb +74 -0
- data/lib/samagotchi/memory_paths.rb +4 -4
- data/lib/samagotchi/model_profile.rb +5 -3
- data/lib/samagotchi/parent_report.rb +34 -4
- data/lib/samagotchi/participant_messages.rb +11 -0
- data/lib/samagotchi/participants.rb +20 -6
- data/lib/samagotchi/plugin/api.rb +2 -1
- data/lib/samagotchi/plugin/sessions.rb +25 -0
- data/lib/samagotchi/remote_command.rb +1 -1
- data/lib/samagotchi/remotes.rb +23 -8
- data/lib/samagotchi/reply_wait.rb +7 -2
- data/lib/samagotchi/review_apply.rb +123 -0
- data/lib/samagotchi/review_command.rb +121 -0
- data/lib/samagotchi/review_start.rb +161 -0
- data/lib/samagotchi/run_options.rb +17 -2
- data/lib/samagotchi/send_command/busy.rb +5 -2
- data/lib/samagotchi/send_command/wait_target.rb +18 -8
- data/lib/samagotchi/send_command.rb +2 -0
- data/lib/samagotchi/session.rb +33 -5
- data/lib/samagotchi/session_access/contract.rb +10 -2
- data/lib/samagotchi/session_access/dispatch.rb +8 -2
- data/lib/samagotchi/session_access/http_transport.rb +10 -1
- data/lib/samagotchi/session_access/local.rb +19 -2
- data/lib/samagotchi/session_access/remote.rb +15 -1
- data/lib/samagotchi/session_access/web_bridge_client.rb +1 -1
- data/lib/samagotchi/session_access.rb +23 -10
- data/lib/samagotchi/session_chain.rb +10 -2
- data/lib/samagotchi/session_continue.rb +4 -3
- data/lib/samagotchi/session_inbox.rb +12 -8
- data/lib/samagotchi/session_manager.rb +30 -8
- data/lib/samagotchi/session_metrics.rb +7 -6
- data/lib/samagotchi/session_participants.rb +3 -1
- data/lib/samagotchi/session_review.rb +28 -0
- data/lib/samagotchi/share_command.rb +7 -1
- data/lib/samagotchi/steer.rb +11 -1
- data/lib/samagotchi/terminal_ui/attached_loop.rb +34 -27
- data/lib/samagotchi/terminal_ui/formatting.rb +2 -2
- data/lib/samagotchi/terminal_ui/one_shot_sink.rb +5 -1
- data/lib/samagotchi/testing/sessions.rb +10 -2
- data/lib/samagotchi/tools/memory.rb +16 -9
- data/lib/samagotchi/turn_checkpoint.rb +13 -0
- data/lib/samagotchi/turn_origin.rb +68 -0
- data/lib/samagotchi/version.rb +1 -1
- data/lib/samagotchi/web/app.rb +108 -21
- data/lib/samagotchi/web/grants.rb +92 -17
- data/lib/samagotchi/web/participant_access.rb +56 -110
- data/lib/samagotchi/web/participant_review.rb +45 -2
- data/lib/samagotchi/web/participant_stream_filter.rb +118 -17
- data/lib/samagotchi/web/participant_view.rb +19 -14
- data/lib/samagotchi/web/participants_admin.rb +129 -0
- data/lib/samagotchi/web/public/app.js +60 -5
- data/lib/samagotchi/web/public/chip_popover.js +10 -3
- data/lib/samagotchi/web/public/data.js +10 -2
- data/lib/samagotchi/web/public/delivery_line.js +79 -15
- data/lib/samagotchi/web/public/index.html +26 -0
- data/lib/samagotchi/web/public/info_bar.js +7 -3
- data/lib/samagotchi/web/public/info_bar_model.js +7 -1
- data/lib/samagotchi/web/public/live_turn.js +3 -0
- data/lib/samagotchi/web/public/participant.html +58 -5
- data/lib/samagotchi/web/public/participant.js +172 -25
- data/lib/samagotchi/web/public/participant_model.js +89 -24
- data/lib/samagotchi/web/public/participant_names.js +37 -5
- data/lib/samagotchi/web/public/participants_panel.js +86 -18
- data/lib/samagotchi/web/public/question_cards.js +1 -0
- data/lib/samagotchi/web/public/review_apply.js +34 -0
- data/lib/samagotchi/web/public/review_start.js +101 -0
- data/lib/samagotchi/web/public/send_turn.js +25 -1
- data/lib/samagotchi/web/public/session_actions.js +44 -3
- data/lib/samagotchi/web/public/session_state.js +3 -0
- data/lib/samagotchi/web/public/start_page.js +38 -2
- data/lib/samagotchi/web/public/stream_handlers.js +10 -0
- data/lib/samagotchi/web/public/turn_html.js +2 -1
- data/lib/samagotchi/web/public/turn_view.js +5 -0
- data/lib/samagotchi/web/session_summary.rb +3 -0
- data/lib/samagotchi/worker.rb +44 -27
- data/lib/samagotchi/worker_inbound.rb +12 -9
- data/lib/samagotchi/working_set.rb +3 -2
- metadata +11 -1
|
@@ -7,8 +7,11 @@ limited and capped; and what they **see** (P4a): their page and its reads, all t
|
|
|
7
7
|
experimental. An agent participant waits on its own turns' replies through the API. The code and docs say
|
|
8
8
|
"participants" and "review", never "shared": `session.shared` already means "attached by default".
|
|
9
9
|
|
|
10
|
-
|
|
11
|
-
|
|
10
|
+
Participants are a **LAN** feature for now (`web.host: lan`; a public URL, `web.public_url`, is planned, not a
|
|
11
|
+
config key yet): a loopback peer with no token is
|
|
12
|
+
the owner, and a reverse proxy on the same machine would make every visitor loopback. A participant's token is the
|
|
13
|
+
participant's wherever it comes from: their link opened on this machine (or on a chi web not on the LAN, whose link
|
|
14
|
+
works on this machine only) is the participant, never the owner.
|
|
12
15
|
|
|
13
16
|
## Grants
|
|
14
17
|
|
|
@@ -38,22 +41,33 @@ participant** and **one role**, until it expires or is revoked.
|
|
|
38
41
|
be read by another user, or isn't this user's (`Grants.check_permissions!`, one message naming the `chmod`). Only
|
|
39
42
|
those two are checked: the state dir above is often 0755, and that's fine. Never point `XDG_STATE_HOME` at a
|
|
40
43
|
shared folder.
|
|
44
|
+
- **A store that doesn't read** (not JSON, a grant without its id, digest or expiry) fails closed: its tokens find no
|
|
45
|
+
grant (a bare 401), it is logged (`grants_unreadable`, once per change of the file), and nothing writes over it, so
|
|
46
|
+
an invite can't keep only its own grant and lose every other digest. The owner's invite, cap, revoke and list are
|
|
47
|
+
refused with one message naming the file (`Grants::Corrupt`: `chi share` exits 1, chi web answers 500 with it);
|
|
48
|
+
an archive or delete still goes ahead. Fix the file, or move it aside to end every link.
|
|
41
49
|
- Rotating the owner token (`chi web --new-token`) never touches grants; `chi share revoke --all` ends them all.
|
|
42
50
|
|
|
43
51
|
## The gate
|
|
44
52
|
|
|
45
53
|
`App#principal_for` resolves every request to a `Web::Principal`:
|
|
46
54
|
|
|
47
|
-
1.
|
|
48
|
-
2. The owner's token (Bearer, then the cookie; `?token=` on the page's trade): the **owner**. Checked first, so the
|
|
55
|
+
1. The owner's token (Bearer, then the cookie; `?token=` on the page's trade): the **owner**. Checked first, so the
|
|
49
56
|
owner's requests never touch the grants store (measured: no change to an owner route's time).
|
|
50
|
-
|
|
57
|
+
2. A `chp_` token (`Grants.token?`) whose grant is active: a **participant** (`Principal.new(kind: :participant,
|
|
58
|
+
grant:)`), from any peer: loopback and a chi web not on the LAN too. An ended or unknown one is refused
|
|
59
|
+
(below), never the owner.
|
|
60
|
+
3. No `chp_` token from a loopback peer, or on a chi web not on the LAN: the **owner** (unchanged).
|
|
51
61
|
4. Anything else: nil. `#token_gate` answers an ended grant's token **401 `token_revoked`** or **401
|
|
52
|
-
`token_expired`** (the page: "This review link
|
|
53
|
-
one."), any other **401
|
|
62
|
+
`token_expired`** (the page says the same words as a sentence: "This review link was revoked by the session's
|
|
63
|
+
owner." / "This review link expired: ask the session's owner for a new one."), any other **401
|
|
64
|
+
`unauthorized`** as before.
|
|
54
65
|
|
|
55
66
|
The `?token=` trade sets the `chi_token` cookie to the token that was presented, the owner's or the participant's
|
|
56
|
-
(one at a time per browser: a participant link opened in the owner's browser replaces the owner's cookie there
|
|
67
|
+
(one at a time per browser: a participant link opened in the owner's browser replaces the owner's cookie there, and
|
|
68
|
+
makes that browser the participant, on loopback too). A grant's token is traded on any peer; the owner's only where
|
|
69
|
+
the gate asks for it. On a peer the gate doesn't ask, the 401 for a grant's cookie that no longer works clears the
|
|
70
|
+
cookie, so that browser is the owner's again at its next request.
|
|
57
71
|
|
|
58
72
|
Then `#route`, for each matching `ROUTES` row:
|
|
59
73
|
|
|
@@ -72,9 +86,9 @@ row answers another session's id 404, so a new route is covered without a new ex
|
|
|
72
86
|
| `POST /api/sessions/:id/turn` | participant | a queued review turn of their own ([Turns](#turns)) |
|
|
73
87
|
| `POST /api/sessions/:id/turn/:eid/dequeue` | participant | their own queued turn back; another's (the owner's included) is 403 `not_permitted` |
|
|
74
88
|
| `GET /api/sessions/resolve?id=` | participant | their session for its id or a prefix of it; anything else 404 as no session (never an ambiguity listing others) |
|
|
75
|
-
| `POST /api/sessions/:id/wait/prepare`, `…/wait` | participant | only for a turn of theirs (`turn`: the enqueued id `POST …/turn` answered; else 403); the answer trimmed to `{status, text, turn_id, cancel_reason}`; a question or approval their turn raised, or their turn held by the owner's step-limit Continue offer ([Turns](#turns)), is `{status: "waiting_for_owner", detail: "waiting for the session's owner"}` with nothing of it |
|
|
89
|
+
| `POST /api/sessions/:id/wait/prepare`, `…/wait` | participant | only for a turn of theirs (`turn`: the enqueued id `POST …/turn` answered; else 403); `wait/prepare` answers only what that wait needs, `{session_id, baseline: {last_turn}, known_turn, live, last_turn_id}` (`last_turn_id` only when it is their turn), never the owner's cursor, message count, question or running turn; the answer trimmed to `{status, text, turn_id, cancel_reason}`, the reply's `text` through `ParticipantView.reply` (no thinking or tool call, redacted) and any other text (an error's exception, a failed turn's summary) `ParticipantMessages::TURN_FAILED`; a question or approval their turn raised, or their turn held by the owner's step-limit Continue offer ([Turns](#turns)), is `{status: "waiting_for_owner", detail: "waiting for the session's owner"}` with nothing of it; a revoke or the expiry ends a `wait` already running (401 `token_revoked` / `token_expired`), as it ends their stream |
|
|
76
90
|
| `GET /` | participant | the participant page's shell (`participant.html`, its body's `data-session` and `data-name` the grant's; `participant.js` reads the rest through the two routes below). Never the owner's page, where every route would refuse them. |
|
|
77
|
-
| `GET /api/sessions/:id/review` | participant | the page's data, filtered ([What a participant sees](#what-a-participant-sees)): `{viewer, session: {id, title, status}, participants, messages, current_turn, waiting_for_owner, queued: {mine, others}, last_event_id}` |
|
|
91
|
+
| `GET /api/sessions/:id/review` | participant | the page's data, filtered ([What a participant sees](#what-a-participant-sees)): `{viewer, session: {id, title, status}, subjects, participants, messages, current_turn, waiting_for_owner, queued: {mine, others}, last_event_id}` |
|
|
78
92
|
| `GET /api/sessions/:id/stream` | participant | the session's stream through `ParticipantStreamFilter` (only `from_seq` and `snapshot` reach the Bridge); it ends within a poll of a revoke or the expiry |
|
|
79
93
|
| `GET /api/info` | participant | `{app, version, features}` (what `SessionAccess::Remote`'s check needs); not `pid`, `cwd`, `lan`, `installed` |
|
|
80
94
|
| `GET /api/sessions/:id` | participant | their session only, whatever the query (`brief`, `cards`, `tail`, `timing`): `{session: {id, title, status, participants: [{id, name, kind, role}]}}` (the active ones). `title` is the session's own title, or "an untitled session": never `display_title`'s fallback, the first prompt's opening words |
|
|
@@ -98,7 +112,9 @@ input, origin `review`, source `participant`, labelled `review`); the body's `cl
|
|
|
98
112
|
|
|
99
113
|
It goes out as `delivery: queue` (D6) with `pending_limit` = the grant's queue limit + 1 (the running one), never
|
|
100
114
|
into the owner's prompt history. The Bridge counts the author's running and queued turns under its event lock and
|
|
101
|
-
answers 429 `too_many_turns` past it; with no worker, their waiting input files are counted
|
|
115
|
+
answers 429 `too_many_turns` past it; with no worker, their waiting input files are counted, and the new one
|
|
116
|
+
written, under the session dir's `participants.lock` (`SessionManager.deliver_turn`), so two at once can't both
|
|
117
|
+
pass. The ack is 202 with
|
|
102
118
|
`delivery: "queue"`; chi web keeps enqueued id → grant (the last 1000), which `dequeue` and `wait` check, falling
|
|
103
119
|
back to a waiting file's author after a restart.
|
|
104
120
|
|
|
@@ -110,9 +126,19 @@ feature (409 `review_unavailable` otherwise: it has no boundary; restart it), an
|
|
|
110
126
|
that may be older holds the session (504 `worker_timeout`: send again). Before a queued participant turn starts, the
|
|
111
127
|
worker checks their link (`participants.json`: revoked, expired) and their cap again: either way the turn is
|
|
112
128
|
dequeued (`:turn_dequeued`) and audited (`revoked`, `cap_reached`) instead of run, so a revoke also stops what they
|
|
113
|
-
had queued
|
|
114
|
-
|
|
115
|
-
|
|
129
|
+
had queued; its settled record (`TurnCheckpoint.record_refused`: canceled, `cancel_reason` the reason) ends their
|
|
130
|
+
wait on it at once, which `ParentReport` reads as status `refused`, exit 1.
|
|
131
|
+
**The owner's input during a review turn queues.** While a participant's turn runs, the owner's input never merges
|
|
132
|
+
into it, from any client (the web, an attached TUI, `chi send` without `--queue`): the Bridge's `POST /turn` makes it
|
|
133
|
+
`delivery: queue` whatever it asked, so it never steers or cuts (`TurnAccumulator#participant_turn?`, under the event
|
|
134
|
+
lock), and its ack and `:turn_enqueued` say `queue`; the worker's drain takes no input file during a participant's
|
|
135
|
+
turn (`Worker#pending_input_drain`, for a file the Bridge never saw), so each runs as the owner's own turn after it.
|
|
136
|
+
The web's delivery line says so (`participantTurn`: Enter queues, no cut), the TUI prints its queued note, `chi send`
|
|
137
|
+
says `(queued: runs after the current turn)` and its `--wait` waits for that turn (`WaitTarget.message`). The owner's
|
|
138
|
+
own turns steer as before. A step-limit Continue of a participant's turn (the owner answers it) continues as theirs: its origin (a `TurnOrigin`,
|
|
139
|
+
`#participant?`; see engine.md) keeps their author (`ContinueOffer#run_continue_turn`), so it runs inside the boundary and on their spend; once their link ended or their cap is reached, the owner's Continue
|
|
140
|
+
ends the offer as a Stop instead (`ContinueOffer#refuse_continue`: decision `refused`, a notice, `not_continued`), so
|
|
141
|
+
nothing waits on it. The step-limit Continue offer of the owner's turn is the
|
|
116
142
|
owner's to answer: while one stands, the worker **holds** a participant's input file (`Worker#run_input_files`,
|
|
117
143
|
`SessionInbox.participant_input?`; an unreadable file counts) instead of running it, which would drop the offer. It
|
|
118
144
|
stays in the inbox: still queued on the Bridge (counted against their queue limit, `turn/dequeue` takes it back),
|
|
@@ -174,7 +200,10 @@ fields: a field added to an event later reaches nobody until it is named there.
|
|
|
174
200
|
`generation_retrying` (`restarted`), `tool_call_started` (the tool's name, and for a file tool the path relative to
|
|
175
201
|
the session's folder when it is inside it; never when that folder is home or `/`), `tool_call_completed` (its status word), and bare markers (the type
|
|
176
202
|
alone) for the queue (`turn_enqueued`, `turn_dequeued`, `input_merged`), the owner's question, approval or Continue
|
|
177
|
-
offer and their answers, and `snapshot` / `reset`: the page re-reads its review data at each
|
|
203
|
+
offer and their answers, and `snapshot` / `reset`: the page re-reads its review data at each (the latest read
|
|
204
|
+
wins), draws no live event from a turn's start or end until that re-read, and then streams again from the data's
|
|
205
|
+
`last_event_id`, so the events after its snapshot replay onto it; a read that fails (unreachable, a 5xx) keeps the
|
|
206
|
+
page and is retried with a backoff under a "retrying" line. Refusals show the server's `detail`. Every other type,
|
|
178
207
|
known (`DROPPED`) or new, is dropped. `spec/web/participant_view_spec.rb` scans every `type: :name` chi emits and
|
|
179
208
|
every handler of the web's stream, and fails until a new one is named in `EVENTS` or `DROPPED`.
|
|
180
209
|
- **The frames** (`Web::ParticipantStreamFilter`). The Bridge's chunks are cut into frames (`\r?\n\r?\n`, a partial
|
|
@@ -182,8 +211,11 @@ fields: a field added to an event later reaches nobody until it is named there.
|
|
|
182
211
|
written again (`id:` the Bridge's cursor when it looks like one, `event:` the filtered type); a comment is a
|
|
183
212
|
`: ping`; anything that doesn't parse is dropped. The reply's text goes out by whole lines, so a secret the model
|
|
184
213
|
streams over two chunks is redacted as one, and a private key block is withheld from its BEGIN line to its END
|
|
185
|
-
line; the rest of a line waits for its end, a tool call, the turn's end or the owner's question (or 400
|
|
186
|
-
characters
|
|
214
|
+
line (or, left open, to the turn's end); the rest of a line waits for its end, a tool call, the turn's end or the owner's question (or 400
|
|
215
|
+
characters: then it is cut at its last space that splits no secret, never inside what `Redact` would redact
|
|
216
|
+
and never after a key word whose value is still to come, `Redact::OPEN_VALUE`; past 1600 with no such space,
|
|
217
|
+
the line's last unbroken run and the rest of that line go out as one `[redacted]`). The owner's stream never
|
|
218
|
+
goes through it (a byte pipe).
|
|
187
219
|
- **The conversation** (`.messages`, over `App#messages_for_display(parts: true)`): a user message only when it is a
|
|
188
220
|
turn's prompt (it has the turn's id) or a person's merged line, and never one from a source that isn't a person's;
|
|
189
221
|
so the owner's `!` line and its output, a delegate's report (a wake turn's too), and the notes chi adds (a declined
|
|
@@ -197,19 +229,39 @@ fields: a field added to an event later reaches nobody until it is named there.
|
|
|
197
229
|
`html` is rendered from the filtered text. The turn in progress (`.current_turn`, over the Bridge snapshot's) gives
|
|
198
230
|
its start's fields, the text so far, its tool rows (with `running`) and `waiting_for_owner`.
|
|
199
231
|
- **The queue.** Their own queued turns (enqueued id and text, for Take back) and how many others wait.
|
|
232
|
+
- **A fork's note.** A review fork (`chi review --from`, `/coordinate review`) starts with a note holding the source's
|
|
233
|
+
recap and, from the coordinator, its handoff's body: a participant's review turn reads it like the rest of the
|
|
234
|
+
history and may quote it (host paths, worktree names). That is by design (it is what the review is about); the
|
|
235
|
+
owner chose to share it. Nothing else of the source comes along.
|
|
236
|
+
- **The subjects** (`subjects`, a review session's: [docs/sessions.md](../sessions.md#review-sessions)): each
|
|
237
|
+
`{path, text, truncated, html}` (`html` for markdown only, rendered from the redacted text), or `{path, missing:
|
|
238
|
+
true}`. Every read checks the path again with `Guardrails::ReviewPaths` (a review turn's own check: under the
|
|
239
|
+
project root, as given and as it resolves, never a secret file or chi's own), so a subject that became a symlink
|
|
240
|
+
out of the project, or a session file edited to name `.env` or `../x`, is `missing`, never read. The text is cut
|
|
241
|
+
at 256 KiB (`SUBJECT_BYTES`) and redacted. The real path is what is checked and opened, with `O_NOFOLLOW`: a
|
|
242
|
+
symlink swapped in for the file itself after the check isn't read. That guards the last path component only: a
|
|
243
|
+
folder on the way swapped for a symlink between the check and the open is still followed. Doing that takes write
|
|
244
|
+
access to the project tree, the owner's, so it isn't a participant's way out; the next read checks again.
|
|
245
|
+
`[]` for a session that isn't a review session. The page's title for a
|
|
246
|
+
review session with no title of its own is `review of docs/plan.md` (`+N` for more), never the first prompt. The
|
|
247
|
+
page shows them as the Plan: beside the thread on a wide screen (≥ 1100 px), a Plan | Thread toggle on a narrower
|
|
248
|
+
one (the thread first, the composer pinned in both views); several subjects get a file picker. It re-reads them
|
|
249
|
+
with the rest at every turn boundary and redraws the Plan only when they changed.
|
|
200
250
|
- **Redaction** (`ParticipantView::Redact`, on every string that goes out): secret shapes (`sk-…`, `ghp_…`,
|
|
201
251
|
`github_pat_…`, `AKIA…`, `xox…-`, `chp_…`, `AIza…`, `rk_live_…`, JWTs, Slack webhooks, private key blocks, an
|
|
202
252
|
`Authorization:` header's value, any `…token` / `…api_key` / `…secret` / `…password` value, `=` or `:`, quoted or
|
|
203
253
|
not, and a URL's password), the owner's web token, the session's folder (shown as relative paths) and the home
|
|
204
254
|
folder (`~`). Defence in depth only: the allowlist is the control; a reply that paraphrases a secret isn't caught.
|
|
205
|
-
- **Errors.** A participant's 404 and 500 carry fixed words, never an exception's (which may name a path).
|
|
255
|
+
- **Errors.** A participant's 404 and 500 carry fixed words, never an exception's (which may name a path); so does their `wait` on a turn that failed (`TURN_FAILED`).
|
|
206
256
|
- **The owner's participant view.** The owner reaches the same reads: `/?as=participant#s=<id>` serves the participant
|
|
207
257
|
page, `GET …/review` is always the filtered view, and `…/stream?as=participant` goes through the same filter, with
|
|
208
258
|
no participant of their own (nothing `mine`, no composer). It is the server's filter, never a page imitating it.
|
|
209
259
|
|
|
210
260
|
The red-team spec (`spec/participant_red_team_spec.rb`) reads the stream, the review, every show variant, `/output`
|
|
211
261
|
and an image as a participant, with an approval, a question, a tool's call and output, thinking, a memory, a steer,
|
|
212
|
-
a delegate report, an unknown event and host paths in the session, and finds none of them.
|
|
262
|
+
a delegate report, an unknown event and host paths in the session, and finds none of them. It also names a secret,
|
|
263
|
+
a file outside the project and a symlink out of it as subjects in the session file and reads none of them through
|
|
264
|
+
`…/review`, and has `chi review` refuse each as a subject.
|
|
213
265
|
|
|
214
266
|
## The owner's controls
|
|
215
267
|
|
|
@@ -220,13 +272,49 @@ carries `qr_svg`, the link's QR, `Web::QR.svg`), revokes and sets caps through t
|
|
|
220
272
|
prompt carries their name and colour (`--author-1…6` in `tokens.css`, by id, the same on both pages), from the saved
|
|
221
273
|
message's `author_name`, `turn_started`'s, or the panel's list (`participant_names.js`).
|
|
222
274
|
|
|
275
|
+
### Apply
|
|
276
|
+
|
|
277
|
+
A review turn proposes; the owner applies (D4, §3 Apply-as-quote). Under each participant's review turn that has a
|
|
278
|
+
reply, the owner's page shows **Apply** (`review_apply.js`; drawn by the history render, `turn_view.js`, and at a live
|
|
279
|
+
turn's end from its `turn_started`'s turn id and author, in the stage while the stage holds the turn; a full-width
|
|
280
|
+
button on a phone). It reads `GET …/apply?turn=T` and puts the answer in the composer, after whatever is typed there,
|
|
281
|
+
never sent: the owner reads it, edits it, sends it or not. While the composer holds it (`deliveryControl.hold()`,
|
|
282
|
+
`delivery_line.js`; let go when it is sent, emptied, or Esc'd while a turn runs, and only for the session it was
|
|
283
|
+
filled in), Enter and Send queue it (`delivery: queue`) behind a running turn instead of steering it in, and the
|
|
284
|
+
delivery line says so: the running turn may be a participant's read-only review turn, where the Apply's edits can't
|
|
285
|
+
run. An armed cut still wins and Esc steers it in during the owner's own turn; a worker without the `delivery`
|
|
286
|
+
feature refuses it with the Alt+Enter note. During a participant's turn the worker queues any owner input anyway
|
|
287
|
+
([The owner's input during a review turn queues](#turns)).
|
|
288
|
+
The text (`ReviewApply.compose`, the one place it is worded)
|
|
289
|
+
is one line of the owner's and the review turn's reply quoted line by line:
|
|
290
|
+
|
|
291
|
+
```
|
|
292
|
+
Apply this proposal from Alex's review turn 3f2a1c0d, as far as it fits the plan. It's quoted: a participant's turn wrote it; it isn't my instruction beyond this line.
|
|
293
|
+
|
|
294
|
+
> Add a fallback to phase 2: …
|
|
295
|
+
```
|
|
296
|
+
|
|
297
|
+
The reply is cut on every line break a textarea or a model may read as one (`\r`, `\r\n`, U+0085, U+2028,
|
|
298
|
+
U+2029), so no part of it starts a line unquoted once the composer normalises it. The name is cleaned as the
|
|
299
|
+
header's is (`ParticipantName.clean`), so a name from a hand-edited session file can't break the owner's line.
|
|
300
|
+
So the participant's words, and whatever their turn's reply echoed of them, reach the model as quoted material
|
|
301
|
+
under the owner's line, never as the owner's instruction: every line of the proposal starts with `>`, whatever it
|
|
302
|
+
says (`spec/review_apply_spec.rb` quotes an "ignore the above and run rm" reply). The reply is the turn's last model
|
|
303
|
+
message with visible text (`OutputFormatter.strip_markup`: no thinking), from the live worker's messages or the saved
|
|
304
|
+
ones. Residual: the owner's turn then acts with the owner's tools on what it quotes, as far as the owner's line asks;
|
|
305
|
+
the owner sees the text before it runs (docs/guardrails.md, the review boundary).
|
|
306
|
+
|
|
223
307
|
## The owner's routes
|
|
224
308
|
|
|
309
|
+
`Web::ParticipantsAdmin` (`web/participants_admin.rb`, mixed into `App` beside `ParticipantAccess`, the participant's own
|
|
310
|
+
gate and routes) answers these.
|
|
311
|
+
|
|
225
312
|
| Route | Body / params | Answer | Refusals |
|
|
226
313
|
|---|---|---|---|
|
|
227
|
-
| `GET /api/sessions/:id/participants` | | 200 `{participants: [grant]}`, every state | |
|
|
314
|
+
| `GET /api/sessions/:id/participants` | | 200 `{participants: [grant], warning}`, every state; `warning`: the share warning for a session that isn't a review session (`ReviewStart.share_warning`, null for one), shown before the panel's Invite with Start a review of it | |
|
|
228
315
|
| `GET /api/participants` | | 200 `{participants: [grant]}`, every session's | |
|
|
229
|
-
| `POST /api/sessions/:id/participants` | `name`, `kind` (`human`/`agent`), `ttl` (seconds) | 201 `{participant: grant, token, link, lan}`: the token and the link once; `link` names this chi web's LAN address (`http://IP:PORT/?token=…#s=<id>`), `lan` false when it has none | 400 `invalid_participant` (name, kind, ttl, an archived session); 404 |
|
|
316
|
+
| `POST /api/sessions/:id/participants` | `name`, `kind` (`human`/`agent`), `ttl` (seconds) | 201 `{participant: grant, token, link, lan, qr_svg, warning}`: the token and the link once; `warning` for a session that isn't a review session (`ReviewStart.share_warning`, null for one); `link` names this chi web's LAN address (`http://IP:PORT/?token=…#s=<id>`), `lan` false when it has none | 400 `invalid_participant` (name, kind, ttl, an archived session); 404 |
|
|
317
|
+
| `GET /api/sessions/:id/apply[?turn=T]` | `turn`: a turn id or a prefix (none: the latest review turn with a reply) | 200 `{text, turn_id, author, author_name}`: the Apply turn for the composer, never sent | 404 `not_found` (no such turn, no review turn), 400 `not_review_turn` (an owner's turn), 409 `no_reply` |
|
|
230
318
|
| `DELETE /api/sessions/:id/participants[?id=p_…]` | | 200 `{revoked: [grant]}`: one participant, or the session's | 400 `invalid_participant` |
|
|
231
319
|
| `DELETE /api/participants` | | 200 `{revoked: [grant]}`: every session's | |
|
|
232
320
|
| `POST /api/sessions/:id/participants/:p/cap` | `cap` (dollars, 0 to 1000) | 200 `{participant: grant}`: their cap from their next turn on | 400 `invalid_participant` (the cap, no such active participant) |
|
|
@@ -242,12 +330,14 @@ this machine only.
|
|
|
242
330
|
|
|
243
331
|
## Files in the session dir
|
|
244
332
|
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
invited to has
|
|
333
|
+
None is in the session JSON (chi web never saves that, and a worker would overwrite a field it added), and
|
|
334
|
+
none is copied to a continue, a fork or a delegate (a continue starts with no participants). A session nobody was
|
|
335
|
+
invited to has none: its files stay byte for byte as they were.
|
|
248
336
|
|
|
249
337
|
- **`participants.json`** (0600, `Participants.write`): `{participants: [{id, kind, name, role, added_at,
|
|
250
|
-
expires_at, removed_at, cap}]}`, rewritten by whoever changes a grant (chi web, `chi share`)
|
|
338
|
+
expires_at, removed_at, cap}]}`, rewritten by whoever changes a grant (chi web, `chi share`), inside the grants
|
|
339
|
+
store's lock (`Grants#update`'s `on_write`), so two writers can't finish out of order and lose a revoke here. Never
|
|
340
|
+
a token or a digest.
|
|
251
341
|
The worker reads it with `Participants.read` (P3a's system-prompt line, `ctx`).
|
|
252
342
|
- **`participants.jsonl`** (0600, append-only, `Participants.log`): one JSON line per event, with `at`: `issued`
|
|
253
343
|
(participant, name, kind, role, expires_at), `revoked` (participant, by), `expired` (the first refused use after the
|
|
@@ -256,6 +346,8 @@ invited to has neither: its files stay byte for byte as they were.
|
|
|
256
346
|
`!line` the Bridge or the worker refused), `turn` (chars, `status: accepted` with its enqueued id, or `refused` with
|
|
257
347
|
the reason: `not_permitted`, `too_many_turns`, `cap_reached`, `review_unavailable`, `worker_timeout`), `cap` (a new
|
|
258
348
|
cap). It goes with the session (retention, delete).
|
|
349
|
+
- **`participants.lock`** (0600, empty): the lock a participant's turn file is counted and written under when no
|
|
350
|
+
worker runs ([Turns](#turns)).
|
|
259
351
|
|
|
260
352
|
## Attribution
|
|
261
353
|
|
|
@@ -294,18 +386,22 @@ The residual injection risk (an owner turn that says "do what Alex said") is in
|
|
|
294
386
|
|
|
295
387
|
## Errors through `--remote`
|
|
296
388
|
|
|
297
|
-
Each condition has one message,
|
|
298
|
-
(`Remote.access_error`, keyed by chi web's error
|
|
389
|
+
Each condition has one message, `ParticipantMessages`' (chi web's `detail`, the Bridge's and the worker's words
|
|
390
|
+
too); its `SessionAccess` class leads it with the remote's label (`Remote.access_error`, keyed by chi web's error
|
|
391
|
+
code, for any route):
|
|
299
392
|
|
|
300
393
|
| Code | Class | Message |
|
|
301
394
|
|---|---|---|
|
|
302
395
|
| 401 `token_revoked` | `TokenRevoked` (an `AuthRefused`) | `this review link was revoked by the session's owner` |
|
|
303
396
|
| 401 `token_expired` | `TokenExpired` (an `AuthRefused`) | `this review link expired: ask the session's owner for a new one` |
|
|
304
|
-
| 403 `not_permitted` | `NotPermitted` | `
|
|
397
|
+
| 403 `not_permitted` | `NotPermitted` | `a participant can't do that: only the session's owner can` |
|
|
305
398
|
| 429 `too_many_turns` | `TooManyTurns` | `this participant has too many turns waiting: wait for one to finish` |
|
|
306
399
|
| 429 `cap_reached` | `CapReached` | `this participant's spending cap is reached: ask the session's owner to raise it` |
|
|
307
400
|
|
|
308
|
-
The server's details are the same words
|
|
401
|
+
The server's details are the same words, with no label. A participant's `wait` on a failed turn answers 200 with
|
|
402
|
+
`text` `this turn failed: the session's owner can see why` (`TURN_FAILED`). A queued turn the worker refused
|
|
403
|
+
because the link ended (`cancel_reason` `revoked`: participants.json reads it removed or expired, which it doesn't
|
|
404
|
+
tell apart) is `ParentReport`'s `refused` with `this review link was revoked or expired` (`TOKEN_ENDED`).
|
|
309
405
|
|
|
310
406
|
A 401 `unauthorized` stays `AuthRefused`'s "the token was refused".
|
|
311
407
|
|
|
@@ -330,7 +426,8 @@ participant TUI in v1.
|
|
|
330
426
|
|
|
331
427
|
## Invariants
|
|
332
428
|
|
|
333
|
-
- The owner is a loopback peer or
|
|
429
|
+
- The owner is the owner's token, or a loopback peer (or a chi web not on the LAN) with no participant token; nothing
|
|
430
|
+
else. A participant token never widens to the owner, from any peer.
|
|
334
431
|
- A participant reaches one session, through the `:participant` rows only; another session is a 404.
|
|
335
432
|
- No token is written anywhere: the grants store has digests, the sidecar and the audit trail have neither.
|
|
336
433
|
- Owner sessions are unchanged: no sidecar, no audit file, no key in the session JSON until a grant exists.
|
|
@@ -342,4 +439,6 @@ participant TUI in v1.
|
|
|
342
439
|
shell line (chi web, the Bridge, the worker), and runs only on a worker with the review boundary, which denies
|
|
343
440
|
everything but reads of the project.
|
|
344
441
|
- A participant's message is never sent without its review header, and never merged into the owner's message.
|
|
442
|
+
- The owner's input is never merged into a participant's running turn (the Bridge queues it, the drain takes none):
|
|
443
|
+
it runs as the owner's own turn after it.
|
|
345
444
|
- A participant's turn never answers or drops the owner's Continue offer: it waits until the owner has.
|
|
@@ -54,8 +54,9 @@ subcommand:
|
|
|
54
54
|
this machine's), runs `RemoteAttachCommand.new(options, access: Remote.new(entry)).run`. A word left over exits 1.
|
|
55
55
|
Without a remote, `--dir` exits 2 ("--dir goes with --remote; cd there instead").
|
|
56
56
|
- Otherwise it calls `Remotes.find`, then `Samagotchi.const_get(klass).new(argv, access: Remote.new(entry)).run`.
|
|
57
|
-
`Remotes::Invalid` (including `NotFound`) exits 2. A `RemoteFailed` that escapes the command prints
|
|
58
|
-
`chi <cmd>: <message>` and exits 1.
|
|
57
|
+
`Remotes::Invalid` (including `NotFound`) exits 2. A `RemoteFailed` or `Refused` that escapes the command prints
|
|
58
|
+
`chi <cmd>: <message>` and exits 1; a `BadRequest` (a value chi web refused, e.g. `sessions list --cwd rel/dir`)
|
|
59
|
+
prints the same line and exits 2.
|
|
59
60
|
|
|
60
61
|
### Contract
|
|
61
62
|
|
|
@@ -129,7 +130,9 @@ the session commands*. Keep that table in step with `SessionAccessRoutes`.
|
|
|
129
130
|
Bridge's 408; 501 → its 404). Anything unmapped becomes `RemoteFailed` "remote NAME (URL) answered STATUS code:
|
|
130
131
|
message".
|
|
131
132
|
- **Transport.** `HTTPTransport#call` turns socket errors into `RemoteFailed` "remote studio (http://…): connection
|
|
132
|
-
refused" (also: no answer within 5 s, a read timeout, can't find host, host unreachable, TLS, a broken
|
|
133
|
+
refused" (also: no answer within 5 s, a read or write timeout, can't find host, host unreachable, TLS, a broken
|
|
134
|
+
connection, and "it didn't answer HTTP" for a reply that isn't HTTP: `Net::HTTPBadResponse`, `ProtocolError`, as
|
|
135
|
+
another server on that port gives). The attached TUI's `WebBridgeClient` reads each as `Unreachable`.
|
|
133
136
|
`ParentWait#run` catches `RemoteFailed` so that `--format json` still prints its error object. Dispatch catches it for
|
|
134
137
|
the other commands.
|
|
135
138
|
- **Auth.** `Remote.access_error`, keyed by chi web's error code on any route: a 401 `unauthorized` → "the token was
|
|
@@ -199,7 +202,7 @@ with a "Machine-local" comment; the rest branch on `@access.remote?` (`SendComma
|
|
|
199
202
|
(`Principal#author`, nil for the owner) and rides with the turn (`SessionManager.deliver_turn(author:)` →
|
|
200
203
|
`BridgeClient#post_turn` → `Bridge#handle_post_turn` → the input file, the fallback's too → the turn's `origin`);
|
|
201
204
|
an owner's turn carries none, so its input file and session are byte for byte as before.
|
|
202
|
-
- **The token at rest.** `remotes.yml` is written through `AtomicFile.write(perm: 0o600)`. `Entry#inspect` / `#to_s`
|
|
205
|
+
- **The token at rest.** `remotes.yml` is written through `AtomicFile.write(perm: 0o600)`, its read-modify-write (`Remotes.put` / `remove`) under `remotes.yml.lock`. `Entry#inspect` / `#to_s`
|
|
203
206
|
redact the token. `chi remote ls` never prints it (JSON shows `token: true|false`). `HTTPTransport#inspect` and
|
|
204
207
|
`Remote#inspect` show only the label.
|
|
205
208
|
- **The Host check.** `local_host_header?` accepts only the loopback names and the exact LAN IP. `http://studio.local`
|
|
@@ -312,6 +315,10 @@ message, so a loop that rescues `IOError` around Bridge calls never crashes on o
|
|
|
312
315
|
|
|
313
316
|
**The stream.** `connect_stream` writes `GET /api/sessions/:id/stream…` through `BridgeClient::StreamRequest` (the
|
|
314
317
|
GET a local stream writes, with `Authorization: Bearer` and `Last-Event-ID`; `Host` is the entry's host and port).
|
|
318
|
+
An IPv6 entry (`http://[::1]:4567`) connects on the bare address (`URI#hostname`, as `HTTPTransport` does) and keeps
|
|
319
|
+
the brackets in `Host`.
|
|
320
|
+
Its connect is bounded by the header timeout (`StreamRequest::CONNECT_TIMEOUT`, 5 s, without one): a dead host's
|
|
321
|
+
SYN isn't waited on for the OS's minutes on every reconnect.
|
|
315
322
|
chi web proxies the Bridge's bytes unchanged (under WEBrick a hijacked body is raw, `Connection: close`). No chunked
|
|
316
323
|
decoding in v1: a `Transfer-Encoding: chunked` reply (a proxy in between) and an https entry are logged
|
|
317
324
|
(`stream_refused`, `chunked_unsupported` / `tls_unsupported`) and read as unreachable; decoding and TLS plug into
|
|
@@ -353,7 +360,7 @@ the closing line reads `stopped` as `unreachable`, the words it always had.
|
|
|
353
360
|
- `live_worker`: `Remote#attach_worker` (`WorkerReply`) with a reason (M5): `stopped` and `unknown_session` (gone),
|
|
354
361
|
`auth_failed` (`AuthRefused`) and `too_old` (`RemoteTooOld`) end at once; `unreachable` (a transport
|
|
355
362
|
`RemoteFailed`) and `worker_gone` (chi web answers, no live worker, not stopped) retry through
|
|
356
|
-
`RECONNECT_DELAYS` (about a minute, P4-D5). A worker gone for `WAKE_AFTER` (3 s, so a restart's new worker isn't
|
|
363
|
+
`RECONNECT_DELAYS` (about a minute, P4-D5; up to two with a 5 s connect timeout per try on a dead host). A worker gone for `WAKE_AFTER` (3 s, so a restart's new worker isn't
|
|
357
364
|
raced) is woken once per outage with `POST …/wake` (P4-D9). `failure` keeps the last message for the closing line.
|
|
358
365
|
- `queues?`/`unqueues?`: the worker's `features`. `ingest_images`: `ImageStore.ingest` into a scratch dir here, then
|
|
359
366
|
`Remote#upload_images`; `close` (`AttachLauncher.run`'s `ensure`) removes the dir.
|
|
@@ -52,7 +52,8 @@ is left out. So is a failed run (`LLMContextStale`'s rule: an `Error` after the
|
|
|
52
52
|
add op `edit`.
|
|
53
53
|
- `memory_read` gives one memory per name (`Tools::MemoryRead.parse_names`; an empty name, the index listing, gives
|
|
54
54
|
none). A partial read ("a,b" where b is missing: the found bodies, then `Error: memory not found: b`) keeps the
|
|
55
|
-
found names only, and its tokens are split evenly among them.
|
|
55
|
+
found names only, and its tokens are split evenly among them. The names come off that line alone
|
|
56
|
+
(`WorkingSet::MISSING`): an orphaned-folder hint may follow it on the next line.
|
|
56
57
|
- `memory_write` gives the memory `call[:path]`, op `write`. A `remove: true` write stays in the set.
|
|
57
58
|
- `web_fetch` gives the URL with its whitespace collapsed.
|
|
58
59
|
|
data/docs/memory.md
CHANGED
|
@@ -21,6 +21,26 @@ Tool behavior:
|
|
|
21
21
|
- `chi memory ls` and `chi memory rm NAME` are the user's side of the same (see [Listing and removing from the shell](#listing-and-removing-from-the-shell)).
|
|
22
22
|
- `write`/`edit` that change a `*.md` right in a scope dir refresh its managed `index.md` line (date, bytes; the description is kept), as `memory_write` does. A memory created with `write` gets a line with no description; any other `.md` written there gets a line too. Model overlays (`<name>.<key>.md` next to `<name>.md`), files in another project's folder and files changed by `execute` are left out.
|
|
23
23
|
|
|
24
|
+
## Moving memories to another machine
|
|
25
|
+
|
|
26
|
+
A project's folder is keyed by its root's absolute path (`<basename>_<8 hex of MD5(root)>`), so project
|
|
27
|
+
memories copied to a machine (or a path) where the repository lives elsewhere sit in a folder chi no
|
|
28
|
+
longer reads. Rename the folder to the new key, or move memories with a bundle zip (see
|
|
29
|
+
[What a bundle owns](#what-a-bundle-owns)).
|
|
30
|
+
|
|
31
|
+
Inside a git repository, when this project's folder is missing or holds no `*.md` while the projects
|
|
32
|
+
dir has a folder of the same basename with another hash, chi says so, naming both folders and the
|
|
33
|
+
`mv` that fixes it (a name match can't prove it's the same project, so nothing is renamed for you):
|
|
34
|
+
|
|
35
|
+
- at session start, a `memory>` load warning (a `:guardrail_warning` with label `memory`; the attached
|
|
36
|
+
TUI, the REPL, `--non-interactive` and the web show it; a UI that attaches later gets it from the
|
|
37
|
+
worker's cards), once per worker or REPL process, so a respawn or resume says it again;
|
|
38
|
+
- under a `memory_read` miss that looked in project scope (`scope: "project"` or none), and under the
|
|
39
|
+
project index read, on a `Hint:` line after `Error: memory not found: …`. A system-scope read never
|
|
40
|
+
gets it.
|
|
41
|
+
|
|
42
|
+
Neither enters the system prompt.
|
|
43
|
+
|
|
24
44
|
## Listing and removing from the shell
|
|
25
45
|
|
|
26
46
|
`chi memory ls [--scope project|system] [--format text|json]` lists the
|
data/docs/plugins.md
CHANGED
|
@@ -988,6 +988,7 @@ ctx.sessions.send(id, "then the docs", delivery: :queue) # after its running tu
|
|
|
988
988
|
ctx.sessions.read(id) # => {id:, title:, status:, parent_id:, running:, messages:} (title: its /title, else its preview)
|
|
989
989
|
ctx.sessions.children # => [{id:, short_id:, state:, branch:, last_reply:, reported:, ...}]
|
|
990
990
|
ctx.sessions.stop(id) # one of this session's own children
|
|
991
|
+
ctx.sessions.review(subjects: ["docs/plan.md"], seed: handoff) # => a review session's id (chi review --from)
|
|
991
992
|
```
|
|
992
993
|
|
|
993
994
|
- `fork(messages:, title: nil, prompt: nil)` starts a child session in its
|
|
@@ -1001,6 +1002,18 @@ ctx.sessions.stop(id) # one of this session's own children
|
|
|
1001
1002
|
`/title` of its own (see [Session titles](sessions.md#session-titles)).
|
|
1002
1003
|
- An image a message names is copied into the child. One whose file is
|
|
1003
1004
|
gone is dropped, with `[image x.png was not copied]` in its message.
|
|
1005
|
+
- `review(subjects: [], seed: nil, recap_wait: 0)` starts a review session of
|
|
1006
|
+
this one, as `chi review --from` does (see [Review sessions](sessions.md#review-sessions)):
|
|
1007
|
+
a new session in this session's folder, on its model and setup, seeded with
|
|
1008
|
+
its recap (never its transcript) and `seed:` (more context, a handoff say),
|
|
1009
|
+
idle, to share with participants (`chi share ID`). This session keeps
|
|
1010
|
+
running, unarchived; the review isn't its child. `subjects:` are project
|
|
1011
|
+
files relative to its folder (a secret or a file outside the project raises
|
|
1012
|
+
`Error` with chi review's one message). It uses the recap already saved: the
|
|
1013
|
+
worker is asked for a fresh one but not waited on unless `recap_wait:` (in
|
|
1014
|
+
seconds) says so, as it runs in this session's own worker. It returns the
|
|
1015
|
+
review session's id. The test kit's `bundle.sessions` answers `review-1`,
|
|
1016
|
+
`review-2`…
|
|
1004
1017
|
- `send(id, text)` sends a user message to a session (an id or a unique
|
|
1005
1018
|
prefix); it runs as a turn, and a stopped session is woken. It waits up to
|
|
1006
1019
|
5 s for the session's worker, so call it from an anytime command or a
|
|
@@ -1345,7 +1358,7 @@ bundles:
|
|
|
1345
1358
|
sentence of the server's `instructions` (from `initialize`), for its line
|
|
1346
1359
|
in `find_tools`.
|
|
1347
1360
|
- **The first run** (no saved list, or the config changed) starts the
|
|
1348
|
-
server in an [init task](#chiinitlabel-provides_tools-false-quiet-false-timeout-nil--ctx--):
|
|
1361
|
+
server in an [init task](#chiinitlabel-provides_tools-false-quiet-false-timeout-nil-failed-nil--ctx--):
|
|
1349
1362
|
every UI shows `Starting MCP server x (first run, saving its tools)`, and
|
|
1350
1363
|
a turn sent meanwhile waits for its tools. A server that doesn't start,
|
|
1351
1364
|
answer or list its tools within `startup_timeout` (each step) is a warn
|
|
@@ -1695,7 +1708,10 @@ parent may Continue: nothing restricts it, as with the step limit. A background
|
|
|
1695
1708
|
its own card and doesn't wake its parent ([sessions.md](sessions.md#delegating)).
|
|
1696
1709
|
|
|
1697
1710
|
The state is one file per session, `<data_dir>/sessions/<session id>.json` (`{"cap": 3.0, "step": 3.0}`), removed
|
|
1698
|
-
with the session.
|
|
1711
|
+
with the session. A file that is there but doesn't read (not JSON, or not a mapping) is logged
|
|
1712
|
+
(`costcap_state_unreadable`) and gets one notice, `cost-cap: <path> doesn't read, its /cap cap is ignored; using
|
|
1713
|
+
default: ($5.00)`: the settings' cap is used, never a silent drop; the next `/cap` or Continue rewrites it, logged
|
|
1714
|
+
(`costcap_state_replaced`) and said (`cost-cap: <path> didn't read; replaced with the new cap`).
|
|
1699
1715
|
|
|
1700
1716
|
Its sibling for work instead of money, tool calls and active minutes across the session's turns, is
|
|
1701
1717
|
[the work-cap bundle](#the-work-cap-bundle): the cap a local model (no cost) can have.
|
|
@@ -1753,7 +1769,11 @@ bundles:
|
|
|
1753
1769
|
- `/workcap off` (or `/workcap 0`): no work cap for this session, over the config.
|
|
1754
1770
|
|
|
1755
1771
|
The state is one file per session, `<data_dir>/sessions/<session id>.json` (`{"tool_calls": {"cap": 800, "step":
|
|
1756
|
-
400}}`, a meter's `"cap": null` for off).
|
|
1772
|
+
400}}`, a meter's `"cap": null` for off). A file that is there but doesn't read (not JSON, or not a mapping) is
|
|
1773
|
+
logged (`workcap_state_unreadable`) and gets one notice, `work-cap: <path> doesn't read, its /workcap caps are
|
|
1774
|
+
ignored; using default.tool_calls: (400)`: the settings' caps are used, never a silent drop; the next `/workcap` or
|
|
1775
|
+
Continue rewrites it, logged (`workcap_state_replaced`) and said (`work-cap: <path> didn't read; replaced with the
|
|
1776
|
+
new cap`).
|
|
1757
1777
|
|
|
1758
1778
|
## The check-in bundle
|
|
1759
1779
|
|
|
@@ -2083,6 +2103,21 @@ by themselves there.
|
|
|
2083
2103
|
report ending with the `/coordinate resume <slug>` to pick it up next
|
|
2084
2104
|
time. It starts, merges and stops nothing: running children stay running
|
|
2085
2105
|
and are named in the report.
|
|
2106
|
+
- **Sprint review (experimental, 0.6.0).** **`/coordinate review [name]`**
|
|
2107
|
+
starts a review session of this coordinator session (`ctx.sessions.review`:
|
|
2108
|
+
its recap, never its transcript; this session keeps running) seeded with the
|
|
2109
|
+
open handoff's body (the one named, the only one, or a card with a Review
|
|
2110
|
+
action each when several are open; with none, the recap alone), and prints
|
|
2111
|
+
the `chi share <id> --name NAME` line. A participant (a manager, a teammate)
|
|
2112
|
+
brings new context there; the skill's Sprint review section (copied into
|
|
2113
|
+
the seed: a participant's turn reads project memories only, and the skill
|
|
2114
|
+
is a system one) has the review's model answer it with a **hand-off diff** (the handoff's lines as
|
|
2115
|
+
they would change, in a `diff` block, and what it means per branch), in a
|
|
2116
|
+
turn that may only read. Your **Apply** under it (the web's) quotes the
|
|
2117
|
+
diff in your turn there: the model brings the handoff up to date and
|
|
2118
|
+
re-plans in words, and starts, stops or merges nothing from the review
|
|
2119
|
+
session: the coordinator session picks the change up from the handoff,
|
|
2120
|
+
merges still asked. Experimental: it may go if it doesn't earn its place.
|
|
2086
2121
|
- **The coordinator toolkit.** The bundle declares `coordinator`: `lean`
|
|
2087
2122
|
plus `delegate`, `delegate_result` and `list_sessions`
|
|
2088
2123
|
([Toolkits](configuration.md#toolkits)). `/coordinate` puts a fresh session
|
data/docs/releasing.md
CHANGED
|
@@ -25,15 +25,20 @@ can run the whole release; the user approves the notes before the tag and the
|
|
|
25
25
|
marked bundle's `requires_chi` to `">= X.Y.Z"` and drops the marker;
|
|
26
26
|
`release:check` fails while a marker is left. chi itself ignores the key,
|
|
27
27
|
and `bundles:check` notes it (and fails a marker that isn't `true` or a
|
|
28
|
-
one-line string). `release:bump` touches no other `requires_chi
|
|
28
|
+
one-line string). `release:bump` touches no other `requires_chi` but a
|
|
29
|
+
profile's (next point);
|
|
30
|
+
- a new `ctx.*` / `chi.*` call a plugin may make gets its release's version in `Plugin::Api::SINCE` once
|
|
31
|
+
released (`chi bundle check`'s `requires-chi-floor` reads it); an unreleased one waits there as a comment;
|
|
29
32
|
- a new shipped bundle joins a profile (`includes:` in `core` or `dev`; a
|
|
30
33
|
spec checks every bundle is in exactly one), and that profile's version
|
|
31
34
|
goes up: `chi update` then installs only the new bundle for those who
|
|
32
35
|
have the profile;
|
|
33
36
|
- a profile's `requires_chi` is its members' highest: a member's raised
|
|
34
|
-
floor
|
|
35
|
-
|
|
36
|
-
|
|
37
|
+
floor raises its profile's too, with the profile's version. `release:bump`
|
|
38
|
+
does both for a profile its `requires_chi_next` raises leave below a
|
|
39
|
+
member (a patch bump of the profile's version, once per release); a floor raised by hand
|
|
40
|
+
needs the profile raised by hand (`bundles:check` notes a profile below a
|
|
41
|
+
member);
|
|
37
42
|
- the release notes say "run `chi update`" and name the bundles whose
|
|
38
43
|
version moved (what changed in each), not per-bundle upgrade steps.
|
|
39
44
|
- Pre-1.0: config and commands may change in a minor version (0.2 → 0.3); a
|
|
@@ -65,7 +70,7 @@ as the GitHub release body.
|
|
|
65
70
|
| `rake lint` / `rake lint:fix` | RuboCop over the repo (must report no offenses; CI runs it) / its safe autocorrect (`rubocop -a`). |
|
|
66
71
|
| `rake gem:validate`, `gem:build`, `gem:install`, `gem:clean` | Check the gemspec; build the gem into `pkg/`; build and install it locally; remove the built gems. |
|
|
67
72
|
| `rake release:draft_changelog` | A draft Unreleased section from the commit subjects since the last tag, grouped. Stdout only. |
|
|
68
|
-
| `rake release:bump[X.Y.Z]` | VERSION, the system manifest, Gemfile.lock, CHANGELOG, and `requires_chi: ">= X.Y.Z"` for each bundle marked `requires_chi_next` (the marker dropped). No commit. |
|
|
73
|
+
| `rake release:bump[X.Y.Z]` | VERSION, the system manifest, Gemfile.lock, CHANGELOG, and `requires_chi: ">= X.Y.Z"` for each bundle marked `requires_chi_next` (the marker dropped), then a profile left below a member's `requires_chi` raised to it, with a patch bump of its version (none when it moved since the last tag) and named in the CHANGELOG's "Update with `chi update`" line. No commit. |
|
|
69
74
|
| `rake release:check` | Clean tracked tree, VERSION == system bundle, a CHANGELOG section, no `requires_chi_next` left, `bundles:check`, `rake lint` (RuboCop) + `npm run lint` (the web frontend's ESLint), rspec (both roots: `spec` and the bundles' own `spec/`) + `rake bundles:specs` + npm test, `gem build`, then a clean install into a temp GEM_HOME that runs `chi --version`, `chi self` and `chi bundle list` with a temp HOME. Needs the network (gem dependencies). |
|
|
70
75
|
| `rake release:notes[X.Y.Z]` | Prints the CHANGELOG section (default: the current VERSION). |
|
|
71
76
|
|
|
@@ -83,7 +88,9 @@ The agent does each step and stops where the user has to say yes.
|
|
|
83
88
|
3. **The user approves the notes and the version.** Show them the section.
|
|
84
89
|
4. **Bump.** `bundle exec rake "release:bump[X.Y.Z]"`, review `git diff`: it
|
|
85
90
|
names the bundles whose `requires_chi` it raised (their `requires_chi_next`
|
|
86
|
-
markers are gone)
|
|
91
|
+
markers are gone) and the profiles it raised with them (a patch bump of
|
|
92
|
+
each one's version, none for a profile already bumped since the last tag),
|
|
93
|
+
which it names in the CHANGELOG's "Update with `chi update`" line.
|
|
87
94
|
5. **Check.** Commit first (the check wants a clean tree), then run it:
|
|
88
95
|
`git commit -am "Release X.Y.Z"` and `bundle exec rake release:check`.
|
|
89
96
|
Fix anything it finds in new commits and run it again.
|