@cotal-ai/connector-core 0.133.10 → 0.133.12

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.
@@ -3,234 +3,612 @@ import { readFileSync } from "node:fs";
3
3
  import { join } from "node:path";
4
4
  import { gunzipSync } from "node:zlib";
5
5
  /** The installed Cotal version, for stamping the orientation card and other surfaces. */
6
- export const DOCS_VERSION = "0.133.10";
6
+ export const DOCS_VERSION = "0.133.12";
7
7
  export function loadDocsMetadata() {
8
8
  return {
9
- "version": "0.133.10",
9
+ "version": "0.133.12",
10
10
  "pages": [
11
11
  {
12
12
  "slug": "what-is-cotal",
13
13
  "title": "What is Cotal",
14
- "kind": "Start here (informative)",
14
+ "kind": "Start here",
15
15
  "category": "Start here",
16
- "summary": "Cotal is an open pub/sub standard for AI agents and software services to work together."
16
+ "summary": "How Cotal lets agents and other software find each other and exchange messages."
17
17
  },
18
18
  {
19
19
  "slug": "getting-started",
20
20
  "title": "Quickstart",
21
- "kind": "Start here (informative)",
21
+ "kind": "Start here",
22
22
  "category": "Start here",
23
- "summary": "Paste this into any coding agent (Claude Code, OpenCode, Cursor, Codex) and it will do the whole page for you:"
23
+ "summary": "Start a local Cotal mesh, launch an agent, and watch it join."
24
24
  },
25
25
  {
26
26
  "slug": "architecture",
27
27
  "title": "Architecture",
28
- "kind": "Concept (informative)",
28
+ "kind": "Concept",
29
29
  "category": "Concept",
30
- "summary": "Cotal is built as a thin waist: the normative wire contract (subjects, message schemas, presence/discovery, delivery semantics, the auth grammar) is the standard (SPEC), and everything else is a pl…"
30
+ "summary": "How the wire contract, broker, connectors, and manager fit together."
31
31
  },
32
32
  {
33
33
  "slug": "mcp-tools",
34
34
  "title": "MCP tool catalog",
35
- "kind": "Reference: the `cotal_*` tool surface every connected agent gets.",
35
+ "kind": "Reference",
36
36
  "category": "Reference",
37
- "summary": "The tools are defined once, platform-neutrally, in @cotal-ai/connector-core and rendered onto each host's native tool API (an MCP server for Claude Code, Codex and Jcode, native plugin tools for Op…"
37
+ "summary": "Arguments, availability, and effects of the Cotal tools exposed to agent sessions."
38
38
  },
39
39
  {
40
40
  "slug": "channels-and-permissions",
41
41
  "title": "Channel permissions",
42
- "kind": "Reference (informative task card)",
42
+ "kind": "Reference",
43
43
  "category": "Reference",
44
- "summary": "Channel permissions decide who can read, who can post, and what each agent tunes into at boot."
44
+ "summary": "Channel read and post permissions, active subscriptions, delivery classes, membership, and replay."
45
45
  },
46
46
  {
47
47
  "slug": "identity-and-auth",
48
48
  "title": "Identity",
49
- "kind": "Concept (informative)",
49
+ "kind": "Concept",
50
50
  "category": "Concept",
51
- "summary": "Who can do what on a mesh, and how it is enforced."
51
+ "summary": "How Cotal identifies a peer and limits what that peer can do."
52
52
  },
53
53
  {
54
54
  "slug": "agent-files",
55
55
  "title": "Agent files",
56
- "kind": "Reference (the persisted form of an agent's identity + persona, read by every launcher)",
56
+ "kind": "Reference",
57
57
  "category": "Reference",
58
- "summary": "An agent's identity and persona live in one Markdown file instead of being passed flag-by-flag, the same shape Claude Code uses for subagents:"
58
+ "summary": "Fields, lookup rules, and ownership for an agent's persisted identity and persona."
59
59
  },
60
60
  {
61
61
  "slug": "api-reference",
62
- "title": "API reference",
63
- "kind": "Reference (informative)",
62
+ "title": "Integration interfaces",
63
+ "kind": "Reference",
64
64
  "category": "Reference",
65
- "summary": "Cotal exposes a wire protocol, TypeScript libraries, CLI commands and agent tools."
65
+ "summary": "Choose Cotal's CLI, endpoint commands, libraries, agent tools, wire protocol, or HTTP interfaces."
66
66
  },
67
67
  {
68
68
  "slug": "auth-api",
69
69
  "title": "Auth HTTP API",
70
- "kind": "Reference (informative)",
70
+ "kind": "Reference",
71
+ "category": "Reference",
72
+ "summary": "HTTP operations, parameters, responses, and authentication for the Auth HTTP interface."
73
+ },
74
+ {
75
+ "slug": "auth-host-api",
76
+ "title": "Auth host HTTP API",
77
+ "kind": "Reference",
71
78
  "category": "Reference",
72
- "summary": "HTTP interface of the stock auth public listener: 11 paths and 12 operations."
79
+ "summary": "HTTP operations, parameters, responses, and authentication for the Auth host HTTP interface."
73
80
  },
74
81
  {
75
82
  "slug": "authoring-a-connector",
76
83
  "title": "Authoring a connector",
77
- "kind": "Reference: describes the TypeScript reference implementation, not the wire contract.",
78
- "category": "Reference",
79
- "summary": "A connector teaches Cotal how to launch one agent harness (Claude Code, OpenCode, your own) as a mesh node."
84
+ "kind": "Guide",
85
+ "category": "Guide",
86
+ "summary": "Add support for an agent application through Cotal's connector interface and extension loader."
87
+ },
88
+ {
89
+ "slug": "backup-a-mesh",
90
+ "title": "Back up a mesh",
91
+ "kind": "Guide",
92
+ "category": "Guide",
93
+ "summary": "Preserve a supported mesh, create an offline backup, and restore it within the original trust boundary."
80
94
  },
81
95
  {
82
96
  "slug": "build-a-client",
83
97
  "title": "Build a Cotal client",
84
- "kind": "Guide (informative)",
98
+ "kind": "Guide",
85
99
  "category": "Guide",
86
- "summary": "This page is the reading order for implementing a Cotal client in another language (Go, Python, Rust, or anything with a NATS client library) against the spec, without reimplementing the protocol."
100
+ "summary": "Implement a client in another language using the wire specification and a NATS client library."
101
+ },
102
+ {
103
+ "slug": "claude-connector-reference",
104
+ "title": "Claude connector reference",
105
+ "kind": "Reference",
106
+ "category": "Reference",
107
+ "summary": "Binding, delivery, presence, event recording, and hosting contracts for the Claude Code connector."
108
+ },
109
+ {
110
+ "slug": "cli-agent-control",
111
+ "title": "Agent terminal control",
112
+ "kind": "Reference",
113
+ "category": "Reference",
114
+ "summary": "Managed seat census, terminal attachment, input receipts, and native agent stops."
115
+ },
116
+ {
117
+ "slug": "cli-agent-views",
118
+ "title": "Agent view reference",
119
+ "kind": "Reference",
120
+ "category": "Reference",
121
+ "summary": "Launch previews, named agent status, and recorded team deployment and removal evidence."
122
+ },
123
+ {
124
+ "slug": "cli-agents",
125
+ "title": "Agent launch reference",
126
+ "kind": "Reference",
127
+ "category": "Reference",
128
+ "summary": "Launch modes, persona definitions, model catalogs, runtimes, and retained PTY seats."
129
+ },
130
+ {
131
+ "slug": "cli-auth",
132
+ "title": "CLI authentication",
133
+ "kind": "Reference",
134
+ "category": "Reference",
135
+ "summary": "Static credentials, endpoint callers, account sessions, actor grants, and credential diagnosis."
136
+ },
137
+ {
138
+ "slug": "cli-backups",
139
+ "title": "CLI backups",
140
+ "kind": "Reference",
141
+ "category": "Reference",
142
+ "summary": "Offline artifacts, integrity checks, restore recovery, and retained seat checkpoints."
143
+ },
144
+ {
145
+ "slug": "cli-endpoints",
146
+ "title": "CLI endpoints",
147
+ "kind": "Reference",
148
+ "category": "Reference",
149
+ "summary": "Presence, local endpoint references, contract authoring, native invocation, and guarded removal."
150
+ },
151
+ {
152
+ "slug": "cli-installation",
153
+ "title": "CLI installation",
154
+ "kind": "Reference",
155
+ "category": "Reference",
156
+ "summary": "Setup, software updates, installed extensions, preferences, completion, and feedback."
157
+ },
158
+ {
159
+ "slug": "cli-integrations",
160
+ "title": "Linear integration",
161
+ "kind": "Reference",
162
+ "category": "Reference",
163
+ "summary": "Linear account configuration, native MCP operations, endpoint serving, and service lifecycle."
164
+ },
165
+ {
166
+ "slug": "cli-maintenance",
167
+ "title": "Manager maintenance",
168
+ "kind": "Reference",
169
+ "category": "Reference",
170
+ "summary": "Guarded issuance-gate repair, retained seat maintenance, and native manager stop impact."
171
+ },
172
+ {
173
+ "slug": "cli-messaging",
174
+ "title": "CLI messaging",
175
+ "kind": "Reference",
176
+ "category": "Reference",
177
+ "summary": "One-shot messages, live chat, channel policy, retained history, and pending direct messages."
178
+ },
179
+ {
180
+ "slug": "cli-observation",
181
+ "title": "CLI observation",
182
+ "kind": "Reference",
183
+ "category": "Reference",
184
+ "summary": "Read-only activity feeds, the operator console, and the dashboard service."
185
+ },
186
+ {
187
+ "slug": "cli-processes",
188
+ "title": "Process supervision",
189
+ "kind": "Reference",
190
+ "category": "Reference",
191
+ "summary": "Manager compatibility entry, owned direct processes, systemd user units, and service logs."
192
+ },
193
+ {
194
+ "slug": "cli-runs",
195
+ "title": "CLI workflow runs",
196
+ "kind": "Reference",
197
+ "category": "Reference",
198
+ "summary": "Hosted and local workflow runs, recorded state, pause answers, offline checks, and seat turns."
199
+ },
200
+ {
201
+ "slug": "cli-selection",
202
+ "title": "CLI spaces",
203
+ "kind": "Reference",
204
+ "category": "Reference",
205
+ "summary": "Space preparation, registration, target selection, discovery, and infrastructure diagnostics."
206
+ },
207
+ {
208
+ "slug": "cli-services",
209
+ "title": "Local service reference",
210
+ "kind": "Reference",
211
+ "category": "Reference",
212
+ "summary": "Saved local services, native adapters, daemon compatibility entries, and service readiness limits."
213
+ },
214
+ {
215
+ "slug": "cli-shutdown",
216
+ "title": "CLI shutdown",
217
+ "kind": "Reference",
218
+ "category": "Reference",
219
+ "summary": "Stack and service stops, process identity checks, preservation, cleanup, and reset."
220
+ },
221
+ {
222
+ "slug": "cli-startup",
223
+ "title": "CLI startup",
224
+ "kind": "Reference",
225
+ "category": "Reference",
226
+ "summary": "Local stack startup, controller recovery, authentication modes, and manifest startup."
227
+ },
228
+ {
229
+ "slug": "cli-usage",
230
+ "title": "CLI usage",
231
+ "kind": "Reference",
232
+ "category": "Reference",
233
+ "summary": "Command discovery, global flags, structured receipts, and exit codes."
87
234
  },
88
235
  {
89
236
  "slug": "cli",
90
- "title": "`cotal` CLI reference",
91
- "kind": "Reference: describes the TypeScript reference implementation (the `cotal` CLI), not the wire contract.",
237
+ "title": "CLI reference",
238
+ "kind": "Reference",
239
+ "category": "Reference",
240
+ "summary": "Find command syntax, flags, receipts, and limits for the Cotal CLI."
241
+ },
242
+ {
243
+ "slug": "codex-connector-reference",
244
+ "title": "Codex connector reference",
245
+ "kind": "Reference",
92
246
  "category": "Reference",
93
- "summary": "cotal is the operator command line for the reference implementation: bring a mesh up, mint identities, launch agents, watch what they do, and tear it all down."
247
+ "summary": "Codex launch options, private credentials, delivery behavior, presence, and structured event limits."
94
248
  },
95
249
  {
96
250
  "slug": "config",
97
251
  "title": "Configuration",
98
- "kind": "Reference: describes the TypeScript reference implementation (the `cotal` CLI and connectors), not the wire contract.",
252
+ "kind": "Reference",
99
253
  "category": "Reference",
100
- "summary": "Four things configure a Cotal workstation: the config file (per-connector settings, notably which of your MCP servers get shared with spawned agents), your preferences (the defaults your own comman…"
254
+ "summary": "Config files, preferences, environment variables, and local storage for the Cotal CLI and connectors."
101
255
  },
102
256
  {
103
257
  "slug": "connect-claude",
104
258
  "title": "Connect Claude",
105
- "kind": "Guide (informative)",
259
+ "kind": "Guide",
106
260
  "category": "Guide",
107
- "summary": "The Claude Code connector turns a real claude session into a Cotal mesh peer."
261
+ "summary": "Connect Claude Code to a mesh, launch an agent, and choose how it receives messages and tools."
108
262
  },
109
263
  {
110
264
  "slug": "connect-codex",
111
- "title": "Connect Codex (beta)",
112
- "kind": "Guide (informative)",
265
+ "title": "Connect Codex",
266
+ "kind": "Guide",
113
267
  "category": "Guide",
114
- "summary": "OpenAI Codex joins a Cotal mesh as a lateral peer: the same cotal tool surface, the same message delivery and attention model as the other connectors, plus mid-turn steering: a directed peer messag…"
268
+ "summary": "Launch Codex on a Cotal mesh, choose a model, and set its sandbox permissions."
115
269
  },
116
270
  {
117
271
  "slug": "connect-hermes",
118
272
  "title": "Connect Hermes (alpha)",
119
- "kind": "Guide (informative)",
273
+ "kind": "Guide",
120
274
  "category": "Guide",
121
- "summary": "Hermes (Nous Research) joins a Cotal mesh as a lateral peer, with the same shared cotal tool surface and delivery model as the other connectors."
275
+ "summary": "Run a Hermes gateway on a Cotal mesh with a managed profile or your own Hermes profile."
122
276
  },
123
277
  {
124
278
  "slug": "connect-jcode",
125
279
  "title": "Connect Jcode (beta)",
126
- "kind": "Guide (informative)",
280
+ "kind": "Guide",
127
281
  "category": "Guide",
128
- "summary": "Jcode joins a Cotal mesh as a lateral peer."
282
+ "summary": "Launch a private Jcode session on a Cotal mesh, choose its model, and fork an existing transcript."
129
283
  },
130
284
  {
131
285
  "slug": "connect-opencode",
132
- "title": "Connect OpenCode (beta)",
133
- "kind": "Guide (informative)",
286
+ "title": "Connect OpenCode",
287
+ "kind": "Guide",
134
288
  "category": "Guide",
135
- "summary": "OpenCode joins a Cotal mesh as a lateral peer, at parity with Claude Code: the same cotal tool surface, the same message delivery and attention model."
289
+ "summary": "Launch OpenCode on a Cotal mesh and choose the model and options for your installed version."
136
290
  },
137
291
  {
138
292
  "slug": "connect-pi",
139
293
  "title": "Connect pi (alpha)",
140
- "kind": "Guide (informative)",
294
+ "kind": "Guide",
141
295
  "category": "Guide",
142
- "summary": "@cotal-ai/pi is Cotal's first host-native framework adapter."
296
+ "summary": "Launch pi on a Cotal mesh or load the Cotal extension into your own pi host."
297
+ },
298
+ {
299
+ "slug": "connector-runtime-reference",
300
+ "title": "Connector runtime reference",
301
+ "kind": "Reference",
302
+ "category": "Reference",
303
+ "summary": "Shared connection recovery, presence display, send receipts, delivery acknowledgement, reply correlation, and resume records."
143
304
  },
144
305
  {
145
306
  "slug": "connectors",
146
307
  "title": "Connectors",
147
- "kind": "Guide (informative)",
308
+ "kind": "Guide",
148
309
  "category": "Guide",
149
- "summary": "Every connector puts a real agent session on the mesh with the same cotal tools, presence, and delivery model (MCP tools)."
310
+ "summary": "Choose an agent application and connect its sessions to a Cotal mesh."
311
+ },
312
+ {
313
+ "slug": "console",
314
+ "title": "Use the console",
315
+ "kind": "Guide",
316
+ "category": "Guide",
317
+ "summary": "Inspect a mesh from the terminal and use authorized operator controls."
318
+ },
319
+ {
320
+ "slug": "control-discovery",
321
+ "title": "Endpoint discovery",
322
+ "kind": "Reference",
323
+ "category": "Reference",
324
+ "summary": "Command contracts, manager instance selection, request outcomes, and service registration."
325
+ },
326
+ {
327
+ "slug": "control-lifecycle",
328
+ "title": "Manager lifecycle contracts",
329
+ "kind": "Reference",
330
+ "category": "Reference",
331
+ "summary": "Managed identities, static slots, spawn goals, chat sessions, terminal access, and grants."
150
332
  },
151
333
  {
152
334
  "slug": "control-surface",
153
335
  "title": "The control surface",
154
- "kind": "Concept (informative)",
336
+ "kind": "Concept",
155
337
  "category": "Concept",
156
- "summary": "Cotal once had a privileged control rail: a fixed set of named service tiers (self / manager / admin / delivery) on their own ctl."
338
+ "summary": "How clients discover commands, address service instances, and follow durable actions."
157
339
  },
158
340
  {
159
341
  "slug": "dashboard-api",
160
342
  "title": "Dashboard HTTP API",
161
- "kind": "Reference (informative)",
343
+ "kind": "Reference",
162
344
  "category": "Reference",
163
- "summary": "HTTP interface of the @cotal-ai/web reference implementation."
345
+ "summary": "HTTP operations, parameters, responses, and authentication for the Dashboard HTTP interface."
164
346
  },
165
347
  {
166
348
  "slug": "define-a-team",
167
349
  "title": "Define a team",
168
- "kind": "Guide (informative)",
350
+ "kind": "Guide",
169
351
  "category": "Guide",
170
- "summary": "The Quickstart gives you one agent. To run a specific team (your own channels, your own agents, and the channel access for each agent), describe it once in a cotal.yaml and launch it with a single…"
352
+ "summary": "Describe agents and channels in a manifest, then boot or deploy that team."
171
353
  },
172
354
  {
173
355
  "slug": "delivery-daemon",
174
- "title": "The delivery daemon (Plane-3)",
175
- "kind": "Concept (informative)",
356
+ "title": "The delivery daemon",
357
+ "kind": "Concept",
176
358
  "category": "Concept",
177
- "summary": "Live channel delivery is at-most-once: a message reaches only the peers subscribed at the moment it is published (SPEC §4)."
359
+ "summary": "Why durable channel delivery needs a trusted service, and what happens without it."
360
+ },
361
+ {
362
+ "slug": "delivery-service-reference",
363
+ "title": "Delivery service contracts",
364
+ "kind": "Reference",
365
+ "category": "Reference",
366
+ "summary": "Fan-out, trusted reads, leases, membership retirement, credential adoption, and daemon lifetime."
178
367
  },
179
368
  {
180
369
  "slug": "deploy",
181
- "title": "Deploying agent teams",
182
- "kind": "Guide (informative)",
370
+ "title": "Deploy agent teams",
371
+ "kind": "Guide",
183
372
  "category": "Guide",
184
- "summary": "The deploy/ tree runs a team of agents in an isolated container that dials out to an existing Cotal broker."
373
+ "summary": "Review the container example, its current build limitation, and the credentials it needs."
374
+ },
375
+ {
376
+ "slug": "embedding-daemons",
377
+ "title": "Embedded daemon lifecycle",
378
+ "kind": "Reference",
379
+ "category": "Reference",
380
+ "summary": "Process runners, account-scoped hosted services, and delivery credential renewal."
381
+ },
382
+ {
383
+ "slug": "embedding-delegated-seats",
384
+ "title": "Delegated seat contracts",
385
+ "kind": "Reference",
386
+ "category": "Reference",
387
+ "summary": "Managed lifecycle handoff, provider closure guarantees, and the limits of delegated recovery contracts."
388
+ },
389
+ {
390
+ "slug": "embedding-endpoints",
391
+ "title": "CotalEndpoint reference",
392
+ "kind": "Reference",
393
+ "category": "Reference",
394
+ "summary": "Presence metadata, observer freshness, write diagnosis, liveness probes, and DM-only endpoint readers."
395
+ },
396
+ {
397
+ "slug": "embedding-exports",
398
+ "title": "Embedding package exports",
399
+ "kind": "Reference",
400
+ "category": "Reference",
401
+ "summary": "Public package entry points, endpoint credentials, and Manager execution contracts."
402
+ },
403
+ {
404
+ "slug": "embedding-manager",
405
+ "title": "Manager embedding authority",
406
+ "kind": "Reference",
407
+ "category": "Reference",
408
+ "summary": "Manager startup, signer custody, remote authority callbacks, and delegated user intent contracts."
409
+ },
410
+ {
411
+ "slug": "embedding-provisioning",
412
+ "title": "Embedded space provisioning",
413
+ "kind": "Reference",
414
+ "category": "Reference",
415
+ "summary": "Broker trust, space credentials, durable host state, and current hosting limitations."
416
+ },
417
+ {
418
+ "slug": "embedding-remote-clients",
419
+ "title": "Embedded remote clients",
420
+ "kind": "Reference",
421
+ "category": "Reference",
422
+ "summary": "MCP conversation routing, browser callers, remote Manager clients, and private-result prerequisites."
423
+ },
424
+ {
425
+ "slug": "embedding-schema-inspection",
426
+ "title": "Space schema inspection",
427
+ "kind": "Reference",
428
+ "category": "Reference",
429
+ "summary": "Resource definitions, bounded read-only observations, and the limits of schema and initialization comparisons."
430
+ },
431
+ {
432
+ "slug": "embedding-service-access",
433
+ "title": "Service endpoint access",
434
+ "kind": "Reference",
435
+ "category": "Reference",
436
+ "summary": "Authority proofs, serving credentials, verified grants, and renewal."
437
+ },
438
+ {
439
+ "slug": "embedding-service-authority",
440
+ "title": "Service authority contracts",
441
+ "kind": "Reference",
442
+ "category": "Reference",
443
+ "summary": "Service authority contracts, platform supervisors, revocation prerequisites, and native custody limits."
444
+ },
445
+ {
446
+ "slug": "embedding-service-callers",
447
+ "title": "Service endpoint callers",
448
+ "kind": "Reference",
449
+ "category": "Reference",
450
+ "summary": "Caller policy grants, broker payload prerequisites, revocation, and recovery limits."
451
+ },
452
+ {
453
+ "slug": "embedding-service-custody",
454
+ "title": "Native service custody",
455
+ "kind": "Reference",
456
+ "category": "Reference",
457
+ "summary": "Immutable service reservations, bootstrap, cancellation, and bounded writer guarantees."
458
+ },
459
+ {
460
+ "slug": "embedding-service-host",
461
+ "title": "Service endpoint hosting",
462
+ "kind": "Reference",
463
+ "category": "Reference",
464
+ "summary": "Owner approvals, native host operations, registration, and lifecycle custody."
185
465
  },
186
466
  {
187
467
  "slug": "embedding",
188
468
  "title": "Embedding Cotal",
189
- "kind": "Guide (informative)",
190
- "category": "Guide",
191
- "summary": "The cotal binary in this repo is one composition root: an operator CLI."
469
+ "kind": "Concept",
470
+ "category": "Concept",
471
+ "summary": "Choose the published packages and authority boundaries for a service built on Cotal."
192
472
  },
193
473
  {
194
474
  "slug": "examples",
195
475
  "title": "Examples",
196
- "kind": "Guide (informative)",
197
- "category": "Guide",
198
- "summary": "Examples live in examples/, one self-contained folder each."
476
+ "kind": "Start here",
477
+ "category": "Start here",
478
+ "summary": "Choose a working example of agents collaborating through Cotal."
479
+ },
480
+ {
481
+ "slug": "feedback-intake-api",
482
+ "title": "Feedback intake HTTP API",
483
+ "kind": "Reference",
484
+ "category": "Reference",
485
+ "summary": "HTTP operations, parameters, responses, and authentication for the Feedback intake HTTP interface."
199
486
  },
200
487
  {
201
488
  "slug": "glossary",
202
489
  "title": "Glossary",
203
- "kind": "Reference (informative)",
490
+ "kind": "Reference",
204
491
  "category": "Reference",
205
- "summary": "One-line definitions of the terms used across these docs and the spec."
492
+ "summary": "Definitions of Cotal's identity, messaging, delivery, and operator terms."
493
+ },
494
+ {
495
+ "slug": "hermes-connector-reference",
496
+ "title": "Hermes connector reference",
497
+ "kind": "Reference",
498
+ "category": "Reference",
499
+ "summary": "Hermes gateway ownership, profile state, delivery rules, presence hooks, and session forks."
500
+ },
501
+ {
502
+ "slug": "identity-authority",
503
+ "title": "Credential authority",
504
+ "kind": "Reference",
505
+ "category": "Reference",
506
+ "summary": "Credential minting, profile grants, endpoint generations, and capability limits."
507
+ },
508
+ {
509
+ "slug": "identity-service-auth",
510
+ "title": "Auth service integration",
511
+ "kind": "Reference",
512
+ "category": "Reference",
513
+ "summary": "Auth-service listeners, pinned IdP proofs, bridge hooks, and owner derivation."
514
+ },
515
+ {
516
+ "slug": "identity-user-auth",
517
+ "title": "User-auth lifecycle",
518
+ "kind": "Reference",
519
+ "category": "Reference",
520
+ "summary": "Actor grants, delegation, catalogs, enrollment, sessions, views, and remote managers."
521
+ },
522
+ {
523
+ "slug": "installation",
524
+ "title": "Install Cotal",
525
+ "kind": "Start here",
526
+ "category": "Start here",
527
+ "summary": "Install the cotal command with the shell installer or npm."
528
+ },
529
+ {
530
+ "slug": "jcode-connector-reference",
531
+ "title": "Jcode connector reference",
532
+ "kind": "Reference",
533
+ "category": "Reference",
534
+ "summary": "Private Jcode process ownership, session forks, readiness checks, model selection, and event delivery."
206
535
  },
207
536
  {
208
537
  "slug": "lang-card",
209
538
  "title": "The cotal-lang card",
210
- "kind": "Reference (informative)",
539
+ "kind": "Reference",
540
+ "category": "Reference",
541
+ "summary": "Effect signatures, result shapes, concurrency rules, and common refusals for cotal-lang programs."
542
+ },
543
+ {
544
+ "slug": "launch-agents",
545
+ "title": "Launch agents",
546
+ "kind": "Guide",
547
+ "category": "Guide",
548
+ "summary": "Launch an agent through a manager, attach to its terminal, and choose its persona and runtime."
549
+ },
550
+ {
551
+ "slug": "manager-console-api",
552
+ "title": "Manager console HTTP API",
553
+ "kind": "Reference",
211
554
  "category": "Reference",
212
- "summary": "One page to write a correct workflow program."
555
+ "summary": "HTTP operations, parameters, responses, and authentication for the Manager console HTTP interface."
213
556
  },
214
557
  {
215
558
  "slug": "manifest",
216
- "title": "Mesh manifest (`cotal.yaml`)",
217
- "kind": "Reference: every field of the mesh manifest.",
559
+ "title": "Mesh manifest (cotal.yaml)",
560
+ "kind": "Reference",
218
561
  "category": "Reference",
219
- "summary": "A manifest (cotal.yaml, kind: Mesh) describes a whole team (its channels, its agents, and who may read and post where) in one file."
562
+ "summary": "Manifest fields, persona overrides, channel grants, and access resolution for one team."
220
563
  },
221
564
  {
222
565
  "slug": "mesh-view",
223
566
  "title": "MeshView",
224
- "kind": "Reference: TypeScript observer surfaces (`MeshView`)",
567
+ "kind": "Reference",
568
+ "category": "Reference",
569
+ "summary": "The TypeScript observer model used by the terminal console and line stream, with dashboard feature coverage."
570
+ },
571
+ {
572
+ "slug": "opencode-connector-reference",
573
+ "title": "OpenCode connector reference",
574
+ "kind": "Reference",
225
575
  "category": "Reference",
226
- "summary": "MeshView is the CLI's shared model for the terminal console and its plain stream."
576
+ "summary": "OpenCode version support, injected configuration, session delivery, and structured event limits."
577
+ },
578
+ {
579
+ "slug": "overview",
580
+ "title": "API reference",
581
+ "kind": "Reference",
582
+ "category": "Reference",
583
+ "summary": "Find Cotal CLI commands, agent tools, configuration fields, and data models."
584
+ },
585
+ {
586
+ "slug": "pi-connector-reference",
587
+ "title": "pi connector reference",
588
+ "kind": "Reference",
589
+ "category": "Reference",
590
+ "summary": "pi host lifecycle, delivery confirmation, continuation attempts, managed recovery, and event persistence."
227
591
  },
228
592
  {
229
593
  "slug": "presence-and-delivery",
230
594
  "title": "Message flow",
231
- "kind": "Concept (informative)",
595
+ "kind": "Concept",
232
596
  "category": "Concept",
233
- "summary": "How peers see each other and how messages reach them: the presence directory, the three delivery modes, and the two delivery guarantees."
597
+ "summary": "How presence, routing, durable delivery, and attention determine what peers can observe and receive."
598
+ },
599
+ {
600
+ "slug": "recover-a-mesh",
601
+ "title": "Recover a mesh",
602
+ "kind": "Guide",
603
+ "category": "Guide",
604
+ "summary": "Use status and logs to diagnose service failures, stuck presence, or a frozen registration gate."
605
+ },
606
+ {
607
+ "slug": "register-a-mesh",
608
+ "title": "Register a mesh",
609
+ "kind": "Guide",
610
+ "category": "Guide",
611
+ "summary": "Choose the mesh a command targets and register remote brokers with verified trust."
234
612
  },
235
613
  {
236
614
  "slug": "release",
@@ -239,6 +617,13 @@ export function loadDocsMetadata() {
239
617
  "category": "Project",
240
618
  "summary": "Cotal uses pnpm, Changesets and one GitHub Actions workflow."
241
619
  },
620
+ {
621
+ "slug": "remote-supervision",
622
+ "title": "Supervise a remote mesh",
623
+ "kind": "Guide",
624
+ "category": "Guide",
625
+ "summary": "Separate broker and manager hosts, publish an exchange, and enroll remote agents."
626
+ },
242
627
  {
243
628
  "slug": "roadmap",
244
629
  "title": "Roadmap",
@@ -249,16 +634,23 @@ export function loadDocsMetadata() {
249
634
  {
250
635
  "slug": "run-a-mesh",
251
636
  "title": "Run a mesh",
252
- "kind": "Guide (informative)",
637
+ "kind": "Guide",
253
638
  "category": "Guide",
254
- "summary": "Day-to-day operation of a local mesh: what cotal up actually runs, how spawning resolves personas, harnesses, and models, how to reach a mesh from any directory, and the operator-only maintenance v…"
639
+ "summary": "Start, inspect, and stop the local stack in a prepared project."
640
+ },
641
+ {
642
+ "slug": "security-boundaries",
643
+ "title": "Host boundaries",
644
+ "kind": "Reference",
645
+ "category": "Reference",
646
+ "summary": "Credential lifetimes, metadata exposure, launch authority, and local process risks."
255
647
  },
256
648
  {
257
649
  "slug": "security",
258
650
  "title": "Security model",
259
- "kind": "Concept (informative threat model)",
651
+ "kind": "Concept",
260
652
  "category": "Concept",
261
- "summary": "Cotal v0 provides containment and sender authenticity for peers sharing one trusted NATS broker."
653
+ "summary": "Threats, guarantees, and limits for peers sharing a trusted NATS broker."
262
654
  },
263
655
  {
264
656
  "slug": "setup-internals",
@@ -267,12 +659,19 @@ export function loadDocsMetadata() {
267
659
  "category": "Project",
268
660
  "summary": "cotal setup (implementations/cli/src/commands/setup.ts) saves configuration by default: it checks prerequisites, sets up the chosen application and runtimes, and seeds persona files."
269
661
  },
662
+ {
663
+ "slug": "setup",
664
+ "title": "Configure a space",
665
+ "kind": "Guide",
666
+ "category": "Guide",
667
+ "summary": "Prepare a project, choose its agent application, and save its space settings."
668
+ },
270
669
  {
271
670
  "slug": "spaces",
272
671
  "title": "Spaces",
273
- "kind": "Concept (informative)",
672
+ "kind": "Concept",
274
673
  "category": "Concept",
275
- "summary": "The space concept, and why it is distinct from a channel."
674
+ "summary": "How spaces isolate collaboration, and how channels, permissions, membership, and conversation ids organize work within them."
276
675
  },
277
676
  {
278
677
  "slug": "stability",
@@ -281,19 +680,33 @@ export function loadDocsMetadata() {
281
680
  "category": "Project",
282
681
  "summary": "Cotal's packages are pre-1.0 and publish in lockstep."
283
682
  },
683
+ {
684
+ "slug": "supervise-processes",
685
+ "title": "Supervise the stack",
686
+ "kind": "Guide",
687
+ "category": "Guide",
688
+ "summary": "Choose process ownership under systemd and monitor actual component health."
689
+ },
284
690
  {
285
691
  "slug": "telemetry",
286
692
  "title": "Telemetry",
287
693
  "kind": "Reference",
288
694
  "category": "Reference",
289
- "summary": "The cotal CLI sends usage data about commands, failures and platforms."
695
+ "summary": "CLI usage telemetry fields, levels, storage, delivery, and opt-outs."
290
696
  },
291
697
  {
292
698
  "slug": "transport",
293
699
  "title": "Transport vs protocol",
294
- "kind": "Concept (informative)",
700
+ "kind": "Concept",
295
701
  "category": "Concept",
296
- "summary": "What in Cotal is the protocol, what is the transport, and what a transport binding must provide."
702
+ "summary": "How Cotal's wire contract uses NATS and JetStream, and what another transport binding would have to preserve."
703
+ },
704
+ {
705
+ "slug": "upgrade-cotal",
706
+ "title": "Upgrade Cotal",
707
+ "kind": "Guide",
708
+ "category": "Guide",
709
+ "summary": "Choose an exact release, prepare the deployment, and verify the upgraded installation."
297
710
  },
298
711
  {
299
712
  "slug": "upgrading",
@@ -305,23 +718,51 @@ export function loadDocsMetadata() {
305
718
  {
306
719
  "slug": "using-cotal",
307
720
  "title": "Choose a workflow",
308
- "kind": "Guide (informative)",
309
- "category": "Guide",
310
- "summary": "Cotal can run a local team, connect a session to a shared space, or expose a service to agents."
721
+ "kind": "Start here",
722
+ "category": "Start here",
723
+ "summary": "Choose how to connect sessions, join spaces, launch teams, and run durable work."
311
724
  },
312
725
  {
313
726
  "slug": "watch-a-mesh",
314
727
  "title": "Watch a mesh",
315
- "kind": "Guide (informative)",
728
+ "kind": "Guide",
729
+ "category": "Guide",
730
+ "summary": "Choose a terminal display, line stream, or read-only browser dashboard for a running mesh."
731
+ },
732
+ {
733
+ "slug": "web-dashboard",
734
+ "title": "Use the web dashboard",
735
+ "kind": "Guide",
316
736
  "category": "Guide",
317
- "summary": "Cotal's watch surfaces show who is present, their reported activity and the messages your credential permits you to read."
737
+ "summary": "Configure the read-only dashboard and inspect a space through a protected browser session."
738
+ },
739
+ {
740
+ "slug": "workflow-effects",
741
+ "title": "Workflow effect contracts",
742
+ "kind": "Reference",
743
+ "category": "Reference",
744
+ "summary": "Seat ownership, budgets, supervision, decisions, presence, turns, cancellation, and placement."
745
+ },
746
+ {
747
+ "slug": "workflow-operations",
748
+ "title": "Workflow operation contracts",
749
+ "kind": "Reference",
750
+ "category": "Reference",
751
+ "summary": "Hosted and local run commands, agent requests, admission, inventory, and keyed submission."
752
+ },
753
+ {
754
+ "slug": "workflow-runtime",
755
+ "title": "Workflow runtime contracts",
756
+ "kind": "Reference",
757
+ "category": "Reference",
758
+ "summary": "Language replay, recovery, wire authority, durable effects, and engine limits."
318
759
  },
319
760
  {
320
761
  "slug": "workflows",
321
762
  "title": "Workflow runs",
322
- "kind": "Concept (informative)",
763
+ "kind": "Concept",
323
764
  "category": "Concept",
324
- "summary": "A workflow run is a program that coordinates agents over hours or days and survives the process that started it."
765
+ "summary": "How a program coordinates agents, records progress, and continues after interruption."
325
766
  }
326
767
  ],
327
768
  "spec": {
@@ -341,12 +782,12 @@ function corpusData() {
341
782
  if (corpusPacked)
342
783
  return corpusPacked;
343
784
  const packed = readFileSync(join(import.meta.dirname, "docs-bundle.bin"));
344
- if (packed.length !== 1011481 || createHash("sha256").update(packed).digest("hex") !== "c3f45289ea025715cdade91f546a7fc191fec70023d1442085fe715b2ddd4a47")
785
+ if (packed.length !== 1096050 || createHash("sha256").update(packed).digest("hex") !== "7ddf0c1637819cd7d28f8ef363d697783ca1914a71d488ab62eb4c670a512946")
345
786
  throw new Error("docs data file docs-bundle.bin beside this module is not the one built with it");
346
787
  return (corpusPacked = packed);
347
788
  }
348
- const sourceBounds = [[0, 2452], [2452, 9118], [9118, 18828], [18828, 34667], [34667, 37458], [37458, 66068], [66068, 71569], [71569, 74836], [74836, 83632], [83632, 87999], [87999, 92168], [92168, 359261], [359261, 377346], [377346, 409245], [409245, 419225], [419225, 425654], [425654, 438238], [438238, 444617], [444617, 449082], [449082, 452659], [452659, 471116], [471116, 475548], [475548, 481738], [481738, 489940], [489940, 493227], [493227, 545272], [545272, 547129], [547129, 550387], [550387, 554134], [554134, 558947], [558947, 564871], [564871, 574322], [574322, 578001], [578001, 581149], [581149, 602137], [602137, 608367], [608367, 620249], [620249, 622860], [622860, 625341], [625341, 629413], [629413, 633608], [633608, 692546], [692546, 695670], [695670, 704967], [704967, 730455], [730455, 968627], [968627, 1006269], [1006269, 1011481]];
349
- const sourceLengths = [5208, 15763, 23039, 47651, 6757, 75407, 12629, 7832, 76592, 10114, 9704, 805600, 47318, 86254, 24768, 15562, 32785, 15375, 9720, 8073, 49834, 25032, 15534, 21252, 7249, 145145, 3758, 8366, 8397, 11335, 13357, 23090, 8770, 6525, 55562, 14726, 29983, 5486, 5367, 9775, 9903, 171720, 6967, 22142, 68170, 688894, 106096, 21676];
789
+ const sourceBounds = [[0, 2205], [2205, 4000], [4000, 8892], [8892, 26133], [26133, 29202], [29202, 33573], [33573, 38604], [38604, 41972], [41972, 50838], [50838, 54990], [54990, 59438], [59438, 61460], [61460, 65471], [65471, 95360], [95360, 110848], [110848, 125978], [125978, 143577], [143577, 158441], [158441, 173021], [173021, 188277], [188277, 207739], [207739, 213455], [213455, 223013], [223013, 239758], [239758, 244127], [244127, 265213], [265213, 274319], [274319, 302617], [302617, 318522], [318522, 341213], [341213, 370740], [370740, 383834], [383834, 385781], [385781, 394610], [394610, 410616], [410616, 418013], [418013, 420697], [420697, 424078], [424078, 427288], [427288, 429333], [429333, 431938], [431938, 436588], [436588, 438357], [438357, 441908], [441908, 452749], [452749, 460710], [460710, 464235], [464235, 469413], [469413, 474324], [474324, 476975], [476975, 484750], [484750, 487727], [487727, 494875], [494875, 497865], [497865, 502515], [502515, 513186], [513186, 524260], [524260, 529152], [529152, 536606], [536606, 539955], [539955, 542526], [542526, 549784], [549784, 553169], [553169, 555379], [555379, 558841], [558841, 562259], [562259, 563373], [563373, 565122], [565122, 568709], [568709, 573230], [573230, 579189], [579189, 589503], [589503, 602084], [602084, 603921], [603921, 615789], [615789, 620905], [620905, 624641], [624641, 627150], [627150, 632196], [632196, 638590], [638590, 644414], [644414, 645161], [645161, 649075], [649075, 654002], [654002, 657380], [657380, 661266], [661266, 665289], [665289, 670091], [670091, 673242], [673242, 676581], [676581, 680628], [680628, 684090], [684090, 695980], [695980, 698798], [698798, 701481], [701481, 704109], [704109, 706600], [706600, 710620], [710620, 715320], [715320, 717539], [717539, 776672], [776672, 779743], [779743, 780723], [780723, 784681], [784681, 792437], [792437, 802467], [802467, 810989], [810989, 815017], [815017, 1053196], [1053196, 1090838], [1090838, 1096050]];
790
+ const sourceLengths = [4844, 4048, 12175, 70032, 8353, 10644, 12640, 8199, 76987, 37758, 10864, 4557, 9872, 81111, 41661, 42535, 50018, 41170, 42207, 41541, 53921, 14375, 25041, 47164, 9798, 60481, 24959, 85706, 44853, 67764, 90821, 36249, 8216, 22028, 42818, 20059, 6278, 8035, 7546, 4835, 5961, 11759, 4195, 8347, 28680, 19623, 8745, 31545, 12472, 6491, 19985, 7140, 18475, 6860, 11538, 27423, 28886, 12022, 18138, 8355, 6090, 18823, 7449, 5100, 8160, 9930, 2248, 5412, 9661, 10786, 14079, 26241, 32147, 4227, 32220, 11735, 9122, 8201, 13307, 15835, 14025, 1464, 8767, 12544, 7818, 9320, 9965, 11921, 6532, 8393, 9633, 8062, 30001, 6519, 6405, 5824, 6007, 9711, 11730, 5283, 172377, 6927, 2023, 8989, 20040, 25734, 20345, 9615, 688910, 106096, 21676];
350
791
  const decodedBodies = [];
351
792
  /** Validate the coupled corpus before the index uses its UTF-16 source bounds. No body is decoded. */
352
793
  export function loadDocsSourceLengths() {
@@ -370,7 +811,7 @@ export function loadDocsSource(source) {
370
811
  export function loadDocsBundle() {
371
812
  const meta = loadDocsMetadata();
372
813
  const count = meta.pages.length;
373
- return { version: DOCS_VERSION, generatedFrom: "docs/*.md + SPEC.md + spec/cotal-lang.md + spec/cotal.schema.json",
814
+ return { version: DOCS_VERSION, generatedFrom: "docs/*.{md,mdx} + SPEC.md + spec/cotal-lang.md + spec/cotal.schema.json",
374
815
  pages: meta.pages.map((page, source) => ({ ...page, body: loadDocsSource(source) })),
375
816
  spec: { ...meta.spec, body: loadDocsSource(count) },
376
817
  lang: { ...meta.lang, body: loadDocsSource(count + 1) },
@@ -379,7 +820,7 @@ export function loadDocsBundle() {
379
820
  /** The compact search index of that bundle: the sibling file docs-index.bin, read, checked and unzipped on the first search. */
380
821
  export function loadDocsIndex() {
381
822
  const packed = readFileSync(join(import.meta.dirname, "docs-index.bin"));
382
- if (packed.length !== 437025 || createHash("sha256").update(packed).digest("hex") !== "38a2250452043505412c3b88172116834add29f4b72d3ecb7d103d2dc183b6c3")
823
+ if (packed.length !== 567901 || createHash("sha256").update(packed).digest("hex") !== "7c85875817cb0bce8fee8439a951a914549a2842a4e0b49628d66202fde6a22b")
383
824
  throw new Error("docs data file docs-index.bin beside this module is not the one built with it");
384
825
  return gunzipSync(packed);
385
826
  }