geneseed 3.10.0 → 3.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (186) hide show
  1. package/CHANGELOG.md +57 -0
  2. package/DESIGN.md +1 -1
  3. package/README.md +26 -44
  4. package/SHIPPED.md +2 -2
  5. package/adapters/bob/README.md +1 -1
  6. package/adapters/claude-code/README.md +17 -12
  7. package/adapters/openclaude/README.md +1 -1
  8. package/adapters/opencode/README.md +4 -4
  9. package/bin/build-driver.mjs +2 -0
  10. package/bin/geneseed-cli.mjs +17 -0
  11. package/bin/geneseed-hook.mjs +2 -0
  12. package/docs/README.md +42 -0
  13. package/docs/_groups.json +18 -0
  14. package/docs/concepts/agents.md +44 -0
  15. package/docs/concepts/collaboration.md +62 -0
  16. package/docs/concepts/exclusions.md +55 -0
  17. package/docs/concepts/footprint.md +52 -0
  18. package/docs/concepts/foreman-mode.md +69 -0
  19. package/docs/concepts/hooks.md +101 -0
  20. package/docs/concepts/hosts.md +55 -0
  21. package/docs/concepts/lsp.md +50 -0
  22. package/docs/{web → concepts}/memory.md +2 -2
  23. package/docs/{web → concepts}/notebook.md +2 -2
  24. package/docs/concepts/rules.md +52 -0
  25. package/docs/concepts/skills.md +49 -0
  26. package/docs/concepts/themes.md +50 -0
  27. package/docs/extending.md +27 -21
  28. package/docs/guides/autostart.md +70 -0
  29. package/docs/guides/choose-your-setup.md +120 -0
  30. package/docs/guides/headless.md +22 -0
  31. package/docs/guides/install.md +161 -0
  32. package/docs/guides/mcp.md +195 -0
  33. package/docs/guides/migrate.md +41 -0
  34. package/docs/guides/project-context.md +87 -0
  35. package/docs/guides/run-anywhere.md +45 -0
  36. package/docs/guides/uninstall.md +51 -0
  37. package/docs/guides/upgrade.md +65 -0
  38. package/docs/guides/verify.md +65 -0
  39. package/docs/guides/wiki.md +69 -0
  40. package/docs/guides/worktree.md +47 -0
  41. package/docs/reference/about.md +7 -0
  42. package/docs/reference/cli.md +7 -0
  43. package/docs/reference/environment.md +99 -0
  44. package/docs/reference/glossary.md +33 -0
  45. package/docs/reference/opencode-plugins.md +131 -0
  46. package/docs/reference/troubleshooting.md +350 -0
  47. package/docs/understand/a-day.md +77 -0
  48. package/docs/understand/enforced-vs-asked.md +64 -0
  49. package/docs/understand/harness.md +36 -0
  50. package/docs/understand/on-your-machine.md +76 -0
  51. package/docs/web-ui.md +1 -1
  52. package/harness.config.json +1 -1
  53. package/js/README.md +3 -2
  54. package/js/build/generate.mjs +12 -1
  55. package/js/build/source.mjs +6 -0
  56. package/js/cli-table.json +1 -1
  57. package/js/hosts/mcp.mjs +1 -1
  58. package/js/hosts/settings.mjs +13 -1
  59. package/js/inspect/checks-authoring.mjs +5 -3
  60. package/js/inspect/doctor.mjs +1 -1
  61. package/js/inspect/inventory.mjs +1 -1
  62. package/js/inspect/registry.mjs +20 -3
  63. package/js/inspect/status.mjs +7 -2
  64. package/js/lib/node-floor.mjs +30 -0
  65. package/js/maintain/setup.mjs +109 -21
  66. package/js/maintain/update.mjs +4 -15
  67. package/js/ui/cli.mjs +2 -2
  68. package/js/web/api.mjs +3 -0
  69. package/js/web/daemon.mjs +52 -0
  70. package/js/web/docs.mjs +149 -65
  71. package/js/web/server.mjs +5 -2
  72. package/package.json +6 -4
  73. package/registry.json +7 -0
  74. package/src/AGENT.md.tmpl +4 -0
  75. package/src/postures/mentor.md +1 -0
  76. package/src/skills/learn-mode.md +89 -0
  77. package/src/skills/pipeline.md +2 -2
  78. package/src/skills/quiz.md +2 -1
  79. package/src/skills/teach.md +2 -1
  80. package/themes/_TEMPLATE.json +1 -0
  81. package/themes/biker.json +1 -0
  82. package/themes/commentator.json +1 -0
  83. package/themes/cyberpunk.json +1 -0
  84. package/themes/gamer.json +1 -0
  85. package/themes/imperial.json +1 -0
  86. package/themes/joker.json +1 -0
  87. package/themes/marvin.json +1 -0
  88. package/themes/mean.json +1 -0
  89. package/themes/military.json +1 -0
  90. package/themes/neutral.json +1 -0
  91. package/themes/pirate.json +1 -0
  92. package/themes/sports.json +1 -0
  93. package/themes/verstappen.json +1 -0
  94. package/themes/wizard.json +1 -0
  95. package/web/dist/assets/Activity-C52LEb-2.js +1 -0
  96. package/web/dist/assets/ActivityDetail-CjNLRvXg.js +1 -0
  97. package/web/dist/assets/Dashboard-B6_sSCHi.js +2 -0
  98. package/web/dist/assets/Docs-Dj7BmCSA.js +5 -0
  99. package/web/dist/assets/{GreenhouseView-D0cbCJ5m.js → GreenhouseView-BALwjQsA.js} +1 -1
  100. package/web/dist/assets/Installs-BbffDQm3.js +2 -0
  101. package/web/dist/assets/JournalView-JpAQ8Hqe.js +1 -0
  102. package/web/dist/assets/Laws-DK7eCWSm.js +3 -0
  103. package/web/dist/assets/Library-CoamHelE.js +1 -0
  104. package/web/dist/assets/{Markdown-CkFyfgNf.js → Markdown-qjM2_ofS.js} +5 -5
  105. package/web/dist/assets/{OperatorHudView-CiAkAkQL.js → OperatorHudView-DVx1HlBx.js} +1 -1
  106. package/web/dist/assets/Personal-eaXb1zcj.js +1 -0
  107. package/web/dist/assets/{Tabs-B4HNrrCs.js → Tabs-BmGtt8E2.js} +1 -1
  108. package/web/dist/assets/api-Dc8f3ca-.js +1 -0
  109. package/web/dist/assets/drawable-Du_PZrQj.js +1 -0
  110. package/web/dist/assets/index-Bz_KMRDH.css +1 -0
  111. package/web/dist/assets/index-CNFH7o55.js +2 -0
  112. package/web/dist/index.html +3 -2
  113. package/QUICKSTART.md +0 -50
  114. package/SETUP.md +0 -1148
  115. package/docs/web/_groups.json +0 -45
  116. package/docs/web/about.md +0 -6
  117. package/docs/web/adapters-claude-code.md +0 -8
  118. package/docs/web/adapters-opencode-loads.md +0 -8
  119. package/docs/web/adapters-opencode-spec.md +0 -8
  120. package/docs/web/adapters-opencode.md +0 -8
  121. package/docs/web/agents.md +0 -8
  122. package/docs/web/authoring.md +0 -11
  123. package/docs/web/autostart.md +0 -9
  124. package/docs/web/claude-hooks.md +0 -37
  125. package/docs/web/cli.md +0 -6
  126. package/docs/web/collaboration.md +0 -27
  127. package/docs/web/configure-wiki.md +0 -9
  128. package/docs/web/design.md +0 -7
  129. package/docs/web/env-knobs.md +0 -9
  130. package/docs/web/exclusions.md +0 -26
  131. package/docs/web/first-session.md +0 -28
  132. package/docs/web/footprint.md +0 -38
  133. package/docs/web/foreman-mode.md +0 -33
  134. package/docs/web/glossary.md +0 -6
  135. package/docs/web/harnesses.md +0 -30
  136. package/docs/web/headless.md +0 -9
  137. package/docs/web/ingest-docs.md +0 -9
  138. package/docs/web/install-paths.md +0 -9
  139. package/docs/web/install-quick.md +0 -35
  140. package/docs/web/lsp-overview.md +0 -37
  141. package/docs/web/mcp-claude-code.md +0 -10
  142. package/docs/web/mcp-filesystem.md +0 -9
  143. package/docs/web/mcp-gitlab.md +0 -9
  144. package/docs/web/mcp-markitdown.md +0 -9
  145. package/docs/web/mcp-overview.md +0 -34
  146. package/docs/web/mcp-trouble.md +0 -9
  147. package/docs/web/mcp-verify.md +0 -9
  148. package/docs/web/migrate.md +0 -39
  149. package/docs/web/model.md +0 -20
  150. package/docs/web/pipelines.md +0 -24
  151. package/docs/web/plugin-activity.md +0 -23
  152. package/docs/web/plugin-context.md +0 -26
  153. package/docs/web/plugin-guard.md +0 -24
  154. package/docs/web/plugin-learn.md +0 -27
  155. package/docs/web/plugin-notify.md +0 -24
  156. package/docs/web/plugin-ponytail.md +0 -23
  157. package/docs/web/plugin-setup.md +0 -7
  158. package/docs/web/plugin-workflow.md +0 -25
  159. package/docs/web/plugins.md +0 -17
  160. package/docs/web/project-context.md +0 -9
  161. package/docs/web/rules.md +0 -30
  162. package/docs/web/run-anywhere.md +0 -9
  163. package/docs/web/self-improve.md +0 -8
  164. package/docs/web/setup-choices.md +0 -64
  165. package/docs/web/skills.md +0 -8
  166. package/docs/web/themes-author.md +0 -20
  167. package/docs/web/themes.md +0 -9
  168. package/docs/web/token-footprint.md +0 -7
  169. package/docs/web/trouble.md +0 -38
  170. package/docs/web/upgrade.md +0 -9
  171. package/docs/web/verify.md +0 -30
  172. package/docs/web/wiki.md +0 -7
  173. package/docs/web/worktree.md +0 -10
  174. package/docs/wiki.md +0 -43
  175. package/web/dist/assets/Activity-BjVp522q.js +0 -1
  176. package/web/dist/assets/ActivityDetail-8ep1bspW.js +0 -1
  177. package/web/dist/assets/Dashboard-OkC_PCH6.js +0 -2
  178. package/web/dist/assets/Docs-CKPWz00o.js +0 -2
  179. package/web/dist/assets/Installs-BtGGdoTt.js +0 -2
  180. package/web/dist/assets/JournalView-Ckl4dmzR.js +0 -1
  181. package/web/dist/assets/Laws-CLpdRRk8.js +0 -3
  182. package/web/dist/assets/Library-wPPuKQrI.js +0 -1
  183. package/web/dist/assets/Personal-D8CnDo9v.js +0 -1
  184. package/web/dist/assets/drawable-BiwaOo6x.js +0 -1
  185. package/web/dist/assets/index-C1yil5j1.js +0 -2
  186. package/web/dist/assets/index-CDPDk2vj.css +0 -1
package/docs/extending.md CHANGED
@@ -26,7 +26,7 @@ Three seams, and almost every question about "where do I edit?" resolves to one
26
26
  | Seam | Source of truth | How it reaches a user | Rebuild needed |
27
27
  |---|---|---|---|
28
28
  | **Harness content** | `src/` (laws, agents, skills, memory/notebook conventions, `AGENT.md.tmpl`) + `themes/*.json` for voice | rendered into a bundle by `geneseed build` / `update` / `rebuild-all` | yes — every active install must be re-emitted |
29
- | **Console docs** | `docs/web/*.md` + `docs/web/_groups.json` | read off disk at request time by `js/web/docs.mjs:101` | no — not even a daemon restart for content |
29
+ | **Docs** | `docs/{understand,guides,concepts,reference}/*.md` + `docs/_groups.json` | read on GitHub as plain markdown, and off disk at request time by `js/web/docs.mjs` | no — not even a daemon restart for content |
30
30
  | **Console app** | `web/src/**` | built by vite into the **tracked** `web/dist/` | yes — rebuild *and commit* dist, then `geneseed web restart` |
31
31
 
32
32
  Two rules follow from the table and they cause most of the surprises:
@@ -34,7 +34,7 @@ Two rules follow from the table and they cause most of the surprises:
34
34
  - **Nothing propagates by itself.** A bundle is a *render*. Editing `src/` changes nothing on any
35
35
  machine until something re-emits (`sourceFingerprint` in `js/build/version.mjs` re-fingerprints, `js/inspect/status.mjs`
36
36
  reports the drift).
37
- - **`docs/web/` is data, `web/src/` is code.** A new documentation page is one file and no
37
+ - **`docs/` is data, `web/src/` is code.** A new documentation page is one file and no
38
38
  rebuild. A new screen is a new hashed chunk and a mandatory `web/dist` commit.
39
39
 
40
40
  ### Counts are computed — never type one
@@ -408,10 +408,11 @@ The `geneseed-` prefix and the `.js` suffix are mechanically load-bearing: the b
408
408
  1. `adapters/opencode/plugins/geneseed-<name>.js` — ESM, zero dependencies. The factory-export
409
409
  convention is real (OpenCode requires it) but **ungated**; the only generic gate on plugin
410
410
  source is `node --check` (the one spawn in `authoringProblems`).
411
- 2. `docs/web/plugin-<name>.md` — `group: plugins`, `title: "geneseed-<name>"`, `kind: "concept"`.
412
- 3. `docs/web/plugins.md` — a bullet. The count above it renders from `{N_PLUGINS}`.
413
- 4. `docs/web/model.md` — a second `{N_PLUGINS}` sentence whose **enumeration of the capabilities
414
- is hand-written and ungated**.
411
+ 2. `docs/reference/opencode-plugins.md` — a `## geneseed-<name>` section (gated: every plugin
412
+ file needs one). The count in its intro renders from `{N_PLUGINS}`.
413
+ 3. `docs/understand/on-your-machine.md` — a row in the OpenCode map table (Piece · What it does
414
+ for you · Kind · Cost · Turn it off). **Hand-written and ungated** beyond the table parsing.
415
+ 4. `docs/concepts/hosts.md` — check the capability matrix still tells the truth.
415
416
  5. `README.md` — **three** sites: the badge, the `N plugins` prose, and the 🔌 Plugins row.
416
417
  6. `SHIPPED.md` — the bare name inside `plugins (…)`; that list must equal the directory exactly,
417
418
  in both directions (`tests/unit/web_api.test.mjs:1655`).
@@ -432,14 +433,20 @@ a row to `js/cli-table.json` with a help string over 20 characters.
432
433
 
433
434
  ### 4c — A documentation page
434
435
 
435
- **One file, no rebuild, no server change.** `docs/web/<id>.md`, where the stem is the id.
436
- Frontmatter is JSON-per-value, not YAML (`js/web/docs.mjs:63-82`):
437
-
438
- - `group` must match an id in `_groups.json` — an unknown group is a **silent skip**.
439
- - `kind` ∈ `markdown | concept | glossary | about | cli`; anything else 404s.
440
- - `harness: "claude"|"opencode"` hides the page from the other host. Note the `plugins` group
441
- carries this at the **group** level, and `hooks` symmetrically — a Claude-relevant page dropped
442
- into `plugins` vanishes with no error.
436
+ **One file, no rebuild, no server change.** `docs/<folder>/<id>.md` — folder ∈ understand,
437
+ guides, concepts, reference; the stem is the id and must be unique across folders (a duplicate
438
+ throws). The same file is what GitHub shows, so write for both
439
+ (`tests/unit/docs_tree.test.mjs` gates it). Frontmatter is JSON-per-value, not YAML
440
+ (`docFrontmatter` in `js/web/docs.mjs`):
441
+
442
+ - `group` must match an id in `docs/_groups.json` — gated by `docs_tree.test.mjs`.
443
+ - `kind` ∈ `markdown | concept | map | glossary | about | cli`; anything else 404s. `map` is a
444
+ concept page whose Piece/Kind/Cost table the console turns into the clickable map.
445
+ - `harness: "claude"|"opencode"` hides the page from the other host — keep it for how-tos that
446
+ cannot run elsewhere; a reference page says its host in its title instead.
447
+ - Link pages with relative `.md` links; the console rewrites them to `#/docs/<id>`. A host-only
448
+ passage is `<!--harness:x-->` + a visible `*(OpenCode only)*` / `*(Claude Code only)*` line.
449
+ - No `{N_*}` token in `understand/` or `guides/` — GitHub would show it raw.
443
450
  - `kind: "markdown"` pulls from a repo file via `source:`, traversal-guarded, optionally sliced to
444
451
  one section with `anchor:` + `slice: true`.
445
452
 
@@ -593,7 +600,7 @@ text or flags is now an ordinary edit: `js/cli-table.json` is the owned document
593
600
  holds. Three hand-written equalities still converge on it and are cheap to keep in step — the
594
601
  29-command count and the hidden-argument rule (`tests/unit/cli_table.test.mjs`), and
595
602
  `tests/unit/docs.test.mjs`, which validates every fenced `geneseed <verb> <flags>` line in
596
- `README.md`, `SETUP.md`, `QUICKSTART.md` and `SHIPPED.md` against the table.
603
+ `README.md`, `SHIPPED.md` and every page under `docs/{understand,guides,concepts,reference}/` against the table.
597
604
 
598
605
  ---
599
606
 
@@ -607,8 +614,8 @@ only, at best, on its presence.
607
614
  | `§N` cross-references into `AGENT.md`'s anatomy | `src/skills/*`, `src/agents/*`, `adapters/**` | **range only.** `constitutionProblems` refuses a `§N` the template declares no section for — which catches a pointer past the end, the shape *removing* a section leaves. It cannot catch one that still resolves and now means something else, which is the shape *inserting* a section leaves, and is what actually happened when `## 2. Doctrines` pushed every later section down one. **Renumbering the anatomy means `grep -rn '§' src/ adapters/` and reading every hit.** Four satellites and a live OpenCode deny message shipped stale because the sweep stopped at `AGENT.md.tmpl` |
608
615
  | Per-law Principle lines | `web/src/pages/Laws.jsx` | presence and class only, never accuracy |
609
616
  | 588 themed constitution titles (42 keys × 14 voices) — `LEX_<ID>` (one per law), `DOC_<ID>` (one per doctrine rule), `PACK_<NAME>` | `themes/*.json` | key presence only — a shipped placeholder is green. `LEX_*` and `DOC_*` are held across the template too, and in both directions; `PACK_*` only across the voices |
610
- | The README keyword enumerations | `README.md`, `docs/web/rules.md` | nothing |
611
- | The plugin capability enumeration | `docs/web/model.md` | nothing (the number substitutes; the list does not) |
617
+ | The README keyword enumerations | `README.md`, `docs/concepts/rules.md` | nothing |
618
+ | The per-host map of what lands on a machine | `docs/understand/on-your-machine.md` | table shape only, never accuracy |
612
619
  | Section labels and page subtitles | `web/src/lib/sections.js`, `web/src/pages/Docs/index.jsx` | nothing |
613
620
  | `THEME_BLURBS` (8 of 14), `ART` (8 of 14) | `js/maintain/setup.mjs`, `js/ui/anim.mjs` | nothing — missing entries fall back silently |
614
621
  | `LOADED_SIGIL` uniqueness | `themes/*.json` | nothing, and it is load-bearing for theme detection |
@@ -678,10 +685,9 @@ answer.
678
685
  - **`AGENT_LESSON_PROMPT` has no drift gate.** Its sibling `LEARN_PROMPT_HEAD` is checked for
679
686
  extractability; this one's parity test was retired. Reformat the declaration in
680
687
  `geneseed-learn.js` and the per-agent lesson prompt silently degrades to a two-line fallback.
681
- - **The fenced-command gate still covers only four documents.** `tests/unit/docs.test.mjs`
682
- validates every `geneseed <verb> <flags>` line against `js/cli-table.json` — but only in
683
- `README.md`, `SETUP.md`, `QUICKSTART.md` and `SHIPPED.md`. Adding `DESIGN.md` and the `docs/`
684
- tree to that array is one line, and it would have caught item 2 on the day it was written.
688
+ - **The fenced-command gate skips the maintainer docs.** `tests/unit/docs.test.mjs` validates
689
+ every `geneseed <verb> <flags>` line against `js/cli-table.json` in `README.md`, `SHIPPED.md`
690
+ and the user docs tree — not in `DESIGN.md` or the `docs/*.md` maintainer pages.
685
691
 
686
692
  ---
687
693
 
@@ -0,0 +1,70 @@
1
+ ---
2
+ group: guides
3
+ order: 10
4
+ title: "Start the web console at login"
5
+ kind: "concept"
6
+ ---
7
+ The web console is the only long-running Geneseed process. `geneseed web start` launches it as a background process on `127.0.0.1:4747` and returns immediately. A login item that runs this command once, with `--no-browser`, leaves the console ready whenever you open [http://127.0.0.1:4747](http://127.0.0.1:4747).
8
+
9
+ ```
10
+ geneseed web start --no-browser # start in the background
11
+ geneseed web status # is it running?
12
+ geneseed web stop # stop it (the login item stays)
13
+ geneseed web restart # restart it, e.g. after an update
14
+ ```
15
+
16
+ Only one console runs at a time. A second `start` does nothing, so logging in twice is harmless. Each machine and each user runs its own console on its own loopback address.
17
+
18
+ > **Always use `web start` in a login item, never bare `web`.** Bare `geneseed web` runs in the foreground and leaves no record of itself. `web stop`, `web restart` and `web status` then cannot see it: they report no live server while it keeps serving. A `restart` would then start a second console that cannot take the busy port.
19
+
20
+ > **This is a file you create. Geneseed never writes or edits a login item**, and that includes `geneseed migrate`. To remove the login item, delete the file.
21
+
22
+ The examples below assume `geneseed` is on your `PATH` (see [Run geneseed from anywhere](run-anywhere.md)). Login items do not see your shell's `PATH`, so always use the absolute path to the launcher. For an npm install, `npm prefix -g` shows where npm keeps it.
23
+
24
+ ## Windows
25
+
26
+ Press **Win+R**, type `shell:startup`, and create a file called `geneseed-web.vbs` in the folder that opens:
27
+
28
+ ```vbs
29
+ ' geneseed-web.vbs: start the Geneseed web console at login (hidden, no browser).
30
+ CreateObject("WScript.Shell").Run "cmd /c ""C:\Users\you\AppData\Local\Geneseed\bin\geneseed.cmd"" web start --no-browser", 0, False
31
+ ```
32
+
33
+ Write out the full path, as shown. VBS does not expand `%LOCALAPPDATA%` inside a string. The script runs hidden, so no console window flashes at login. To disable it, delete the file.
34
+
35
+ If you would rather use a scheduled task:
36
+
37
+ ```powershell
38
+ schtasks /Create /TN "Geneseed Web" /SC ONLOGON /TR "\"%LOCALAPPDATA%\Geneseed\bin\geneseed.cmd\" web start --no-browser" /RL LIMITED /F
39
+ schtasks /Delete /TN "Geneseed Web" /F # to remove it
40
+ ```
41
+
42
+ ## macOS
43
+
44
+ Create a LaunchAgent at `~/Library/LaunchAgents/dev.geneseed.web.plist`. Set `RunAtLoad` and **no** `KeepAlive`. The launcher exits as soon as it has started the background process, which keeps running on its own.
45
+
46
+ ```xml
47
+ <?xml version="1.0" encoding="UTF-8"?>
48
+ <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN"
49
+ "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
50
+ <plist version="1.0">
51
+ <dict>
52
+ <key>Label</key> <string>dev.geneseed.web</string>
53
+ <key>ProgramArguments</key>
54
+ <array>
55
+ <string>/Users/you/.local/bin/geneseed</string>
56
+ <string>web</string>
57
+ <string>start</string>
58
+ <string>--no-browser</string>
59
+ </array>
60
+ <key>RunAtLoad</key> <true/>
61
+ </dict>
62
+ </plist>
63
+ ```
64
+
65
+ `/Users/you/.local/bin/geneseed` is where `./geneseed link` puts the launcher by default. Replace it with your own absolute path. Then load the agent, which also starts the console now:
66
+
67
+ ```bash
68
+ launchctl load ~/Library/LaunchAgents/dev.geneseed.web.plist # enable and start now
69
+ launchctl unload ~/Library/LaunchAgents/dev.geneseed.web.plist # disable
70
+ ```
@@ -0,0 +1,120 @@
1
+ ---
2
+ group: guides
3
+ order: 2
4
+ title: "Choose your setup"
5
+ kind: "concept"
6
+ ---
7
+ The setup wizard asks a handful of questions before it builds. Every one has a safe default, so you can accept them all and move on. This page says what each one changes, so you can pick on purpose, and how to change it later.
8
+
9
+ All of these choices are made **at build time**. The build writes them into the files your agent loads. Nothing switches at runtime. Rebuilds, re-themes and upgrades keep each install's choices, because they are recorded in small marker files beside the install.
10
+
11
+ > **You already know this:** these are compiler flags. You set them once, the output is built from them, and changing one means rebuilding rather than editing the output by hand.
12
+
13
+ ## Theme: the voice
14
+
15
+ A theme changes how the harness *sounds*: the banner, the readiness sigil the agent opens with, and the vocabulary of its prose. It never changes which rules apply or which files ship. The wizard previews each theme live as you move through the list.
16
+
17
+ `neutral` is plain English. The others are `imperial`, `military`, `pirate`, `wizard`, `cyberpunk`, `gamer`, `sports`, `biker`, `commentator`, `joker`, `marvin`, `mean` and `verstappen`.
18
+
19
+ ```
20
+ geneseed build --emit opencode-global --theme imperial
21
+ ```
22
+
23
+ More in [Themes](../concepts/themes.md).
24
+
25
+ ## Posture: how the agent works with you
26
+
27
+ Posture is the relationship register, fixed at build time so it does not drift mid-session:
28
+
29
+ - **peer** *(default)*: a candid equal. Dense, challenges you, no flattery.
30
+ - **mentor**: explains the why and checks your understanding.
31
+ - **expert**: maximum density, no basics.
32
+ - **assistant**: precise execution, low initiative. You steer.
33
+ - **artisan**: a peer with toolsmith reflexes, terminal-first.
34
+
35
+ ```
36
+ geneseed build --emit opencode-global --posture mentor
37
+ ```
38
+
39
+ Pick **peer** unless you know you want another register. A theme changes the prose, while a posture changes the relationship. See [Collaboration](../concepts/collaboration.md).
40
+
41
+ ## Mode: who does the work
42
+
43
+ - **direct** *(default)*: the agent works every task itself, turn by turn.
44
+ - **foreman**: the session sorts each incoming task. A trivial task gets a direct answer. A substantial task goes to a small crew of agents (a **pipeline**) running in its own git worktree, while the session keeps answering you.
45
+
46
+ A pipeline never commits or merges. It hands back its worktree uncommitted, together with its test and lint output. The session then re-runs those commands itself, shows you the diff and the passing output, and commits and merges only after you accept. Foreman mode costs more per substantial task, because several agents run instead of one. In exchange, the session stays responsive.
47
+
48
+ ```
49
+ geneseed build --emit opencode-global --mode foreman
50
+ geneseed build --emit opencode-global --mode direct # back to the default
51
+ ```
52
+
53
+ More in [Foreman mode](../concepts/foreman-mode.md).
54
+
55
+ ## Doctrine packs: which practices bind
56
+
57
+ The harness's rules come in tiers (see [Rules](../concepts/rules.md)). The Ethos and the Rules are always on. The **doctrines** are practices rather than principles, and they ship as packs you choose:
58
+
59
+ | Pack | What it governs |
60
+ | --- | --- |
61
+ | **craft** | how code is written: reuse first, house conventions, docs updated in the same change, the smallest diff |
62
+ | **rigor** | how work is proven: idempotence, honest tests, cover-and-verify, gates that can actually fail |
63
+ | **ops** | how the machine is driven: tool discovery, commands that return, complete teardowns |
64
+ | **process** | how a session runs: planning, context economy, docs first, bounded loops, and consent before every commit and push |
65
+ | **comms** | how answers are presented: stable reference codes on tracked items, and a diagram or table only where it earns its place |
66
+
67
+ Every pack is enabled by default. To keep only some packs, or none:
68
+
69
+ ```
70
+ geneseed build --emit opencode-global --doctrines craft,rigor # two packs
71
+ geneseed build --emit opencode-global --doctrines none # Ethos and Rules only
72
+ ```
73
+
74
+ The packs always load in the same order (craft, rigor, ops, process, comms), whatever order you type them in. A pack you leave out still ships on disk under `doctrines/`, so you can read it before you turn it on. A clone can set its own default in `harness.config.json` with a `doctrines` array.
75
+
76
+ **Dropping `process` changes what the machine does, not only what the agent reads.** The *Consent Before Push* rule in that pack is enforced at the tool boundary as well as in the prose:
77
+
78
+ - On Claude Code and OpenClaude, the git hook stays wired but stops asking before a commit or push.
79
+ - On OpenCode, a fresh install no longer gets the `git commit*` and `git push*` ask entries in `opencode.json`. On an existing install, entries that are already there are left in place and reported, because Geneseed cannot tell its own entries from ones you typed.
80
+
81
+ The refusals of destructive git and `rm -rf` belong to the always-on Rules, not to the pack, so they stay in every build. See [Enforced vs. asked](../understand/enforced-vs-asked.md).
82
+
83
+ ## One rule at a time
84
+
85
+ A pack is all-or-nothing. `--exclude-rules` drops single doctrine rules instead. It takes rule addresses, written `<pack> <n>` or `<pack>.<n>`:
86
+
87
+ ```
88
+ geneseed build --emit opencode-global --exclude-rules "process 7"
89
+ geneseed build --emit opencode-global --exclude-rules "process 5,craft 2"
90
+ geneseed build --emit opencode-global --exclude-rules none
91
+ ```
92
+
93
+ The number in an address is the rule's position in its pack, so it can change if a rule is added or removed. To see the current addresses, pass an address that does not exist: the build refuses it and lists every valid address. The web console's **Constitution** page has one switch per rule. You stage the changes there and apply them in a single rebuild.
94
+
95
+ Excluding *Consent Before Push* (`process 5` today) takes the commit and push consent gate with it, exactly as dropping the whole `process` pack does. The console and the wizard both warn you before applying it. A pack whose every rule is excluded drops out of the build entirely. See [Exclusions](../concepts/exclusions.md) for excluding whole folders instead.
96
+
97
+ ## Footprint: how much loads every turn
98
+
99
+ Footprint controls how much of the rules text sits inside `AGENT.md`, which is loaded on every turn. It changes the token cost, not which rules apply:
100
+
101
+ - **lean** *(default)*: each rule appears in a hand-written short form, with a pointer to the full text. The full text ships beside `AGENT.md`, and the agent reads it when a rule's nuance matters.
102
+ - **full**: every rule's complete text and rationale is inline. This costs the most tokens. It can help a smaller model, which applies a rule's nuance more reliably when the reasoning is always in front of it.
103
+
104
+ ```
105
+ geneseed build --emit opencode-global --footprint full
106
+ ```
107
+
108
+ Both footprints install the same agents, skills, hooks and plugins. More in [Footprint](../concepts/footprint.md).
109
+
110
+ ## Changing a choice later
111
+
112
+ You have three ways to change a choice:
113
+
114
+ - **Re-run the wizard** with `geneseed setup`. It pre-selects what the install already has, so holding Enter cannot widen a set you narrowed on purpose. The wizard does not ask about single rules, but it keeps any rule exclusions already in place.
115
+ - **Use the web console** (`geneseed web`). **Settings** and the **Harnesses** page change theme, footprint and the rest per install. **Constitution** toggles packs and rules.
116
+ - **Run the build yourself.** Watch out: a flag you leave out takes the *generator's* default, not your install's current value. `geneseed status --json` prints, for every install, the exact `geneseed build` command that rebuilds it as it is. Start from that command and change the one flag you want.
117
+
118
+ ---
119
+
120
+ **Next:** [Verify it works](verify.md)
@@ -0,0 +1,22 @@
1
+ ---
2
+ group: guides
3
+ order: 11
4
+ title: "Run in CI / headless"
5
+ kind: "concept"
6
+ harness: "opencode"
7
+ ---
8
+ Once the harness is installed for OpenCode (global or per repo), OpenCode can run **non-interactively**, without its terminal UI. The harness's rules, agents and skills then apply in scripts and pipelines too:
9
+
10
+ ```
11
+ opencode run "review the staged diff and list any correctness bugs" # one shot, prints to stdout
12
+ opencode run -m anthropic/claude-sonnet-4-5 "…" # pin a model for this run
13
+ cat issue.md | opencode run "triage this and propose a fix plan" # pipe input in
14
+ ```
15
+
16
+ `opencode run` loads the same `opencode.json` (its `instructions` pointing at `AGENT.md`, its permission rules, any per-agent overrides) and the same agents, skills and plugins as an interactive session. Geneseed writes nothing extra for this. It is ordinary OpenCode usage.
17
+
18
+ ## Things to know
19
+
20
+ - **Permission prompts still apply, and in CI nobody can answer them.** Any command the config marks `ask` blocks a non-interactive run: `rm -rf`, and `git commit` and `git push` whenever the *Consent Before Push* rule is built in (it is part of the `process` pack; see [Choose your setup](choose-your-setup.md)). A CI job that has to commit should set those commands back to `"allow"` in its own `permission.bash` map, or limit the run to read-only work. Do not disable the guards wholesale.
21
+ - **`--pure`** runs OpenCode without any local or global config. Use it to reproduce a bug without the harness in the way, or to confirm that a behaviour comes from the harness.
22
+ - **The plugins still load.** The context plugin injects the repo's docs, and the learn plugin still writes memory when the session goes idle. To change their behaviour for a run, set `GENESEED_GUARD=warn` or `off`, `GENESEED_CONTEXT_INJECT=off`, or `GENESEED_DEBUG=1`. See [Environment](../reference/environment.md) and [OpenCode plugins](../reference/opencode-plugins.md).
@@ -0,0 +1,161 @@
1
+ ---
2
+ group: guides
3
+ order: 1
4
+ title: "Install"
5
+ kind: "concept"
6
+ ---
7
+ Geneseed builds a harness (the rules, agents, skills and hooks your AI coding tool loads; see [What a harness is](../understand/harness.md)) and installs it into the tool you already use. Most people need one command.
8
+
9
+ ## The 5-minute path
10
+
11
+ The only prerequisite is **Node 22.3 or newer**.
12
+
13
+ ```
14
+ npx geneseed setup
15
+ ```
16
+
17
+ The command is the same on macOS, Linux and Windows (cmd, PowerShell or any POSIX shell). The setup wizard lists the AI coding tools it found on your `PATH`, then asks for a theme, a posture, a mode, the doctrine packs, an install mode and a footprint. Each one has a safe default, so you can hold Enter through all of them. [Choose your setup](choose-your-setup.md) explains each question. **OpenCode global** is the recommended install mode: you install once and every repo inherits it, with nothing committed into your projects. The wizard then builds the harness and ends with a short summary: the root file your tool loads and where it was written, the hooks it wired (Claude Code, Bob and OpenClaude), whether memory learning is on, which tool to restart, and a link to what was installed. It then offers to run a health check.
18
+
19
+ To keep the command on your machine:
20
+
21
+ ```
22
+ npm install -g geneseed
23
+ ```
24
+
25
+ This puts three commands on your `PATH`: `geneseed` (the CLI you type), `geneseed-build` (the generator) and `geneseed-hook` (what the host tool calls on every tool use, which you never type yourself).
26
+
27
+ Next: [Verify it works](verify.md). To see what the install just wrote, read [What lands on your machine](../understand/on-your-machine.md).
28
+
29
+ ## From a clone
30
+
31
+ Clone the repository when npm is out of reach (for example, a corporate network with no registry access), or when you want to change the harness rather than just use it. A clone needs **git** as well as Node 22.3 or newer. git is what updates the clone.
32
+
33
+ Each OS has a one-step installer at the root of the clone. It checks for Node and git. If one is missing, it names what to install and where to get it, then stops. **It never installs anything itself.** When the checks pass, it runs the setup wizard and offers to open the web console.
34
+
35
+ ```bash
36
+ git clone https://github.com/Arylmera/Geneseed.git
37
+ cd Geneseed
38
+ ./install # macOS, Linux, or a POSIX shell on Windows
39
+ ```
40
+
41
+ - **macOS**: you can also double-click `install.command` in the Finder. It opens in Terminal.
42
+ - **Windows**: double-click `install.cmd` in Explorer, or run it from cmd or PowerShell. It needs no bash, WSL or PowerShell script.
43
+
44
+ ```powershell
45
+ git clone https://github.com/Arylmera/Geneseed.git
46
+ cd Geneseed
47
+ .\install.cmd
48
+ ```
49
+
50
+ Later, run the launcher in the clone: `./geneseed setup` (Windows: `.\geneseed.cmd setup`) re-runs the wizard, and bare `./geneseed` opens the web console. Both launchers need `node` on `PATH`. If it is not there (some version managers only patch interactive shells), set `GENESEED_NODE` to the absolute path of the Node binary.
51
+
52
+ From a clone, every `geneseed …` command on these pages is `./geneseed …` (Windows: `.\geneseed.cmd …`). To drop the `./`, see [Run geneseed from anywhere](run-anywhere.md).
53
+
54
+ ## Prerequisites
55
+
56
+ - **Node 22.3 or newer.** This is the only hard requirement. Geneseed has zero runtime dependencies, and nothing it installs needs a second interpreter.
57
+ - **Your agent tool**: OpenCode (recommended), Claude Code, IBM Bob, OpenClaude, or any tool that reads a root instructions file.
58
+ - **git**, for a clone only. A clone updates itself with `git pull`.
59
+ - *Optional:* a document converter (MarkItDown, Pandoc or Docling) if you want the agent to read PDFs and Office files. See [MCP servers](mcp.md#reading-non-markdown-docs).
60
+
61
+ ## Without the wizard
62
+
63
+ `setup` needs an interactive terminal. In a script, a CI job, or any shell without one, it stops with exit code 1 and prints the build command to run instead:
64
+
65
+ ```
66
+ geneseed build --emit opencode-global --theme neutral
67
+ ```
68
+
69
+ `geneseed build` takes the same flags as the generator `geneseed-build`. `--emit` picks the host and its scope: `files`, `opencode`, `opencode-global`, `claude`, `claude-global`, `bob`, `bob-global`, `openclaude` or `openclaude-global`. A `-global` emit writes into the tool's own config directory. A project emit writes into the repo you name with `--out <repo> --root <repo>`. All the other flags (`--theme`, `--footprint`, `--posture`, `--mode`, `--doctrines`, `--exclude-rules`) are covered in [Choose your setup](choose-your-setup.md).
70
+
71
+ To test a build before writing anything, use `geneseed validate` with the same flags. See [Verify](verify.md).
72
+
73
+ ## Install paths, one per host
74
+
75
+ The wizard runs one of these for you. Use them directly when you script an install, or when you want a scope the wizard did not offer you.
76
+
77
+ ### OpenCode, global (recommended)
78
+
79
+ ```
80
+ geneseed build --emit opencode-global
81
+ ```
82
+
83
+ This writes into OpenCode's config directory: `$OPENCODE_CONFIG_DIR`, else `$XDG_CONFIG_HOME/opencode`, else `~/.config/opencode` (on Windows too: `C:\Users\<you>\.config\opencode`). The install contains `AGENT.md`, `agents/`, `skills/`, the plugins, the `memory/` store, and a merged `opencode.json` whose `instructions` key points at `AGENT.md`. Every repo you open in OpenCode inherits it. You do not need a per-repo file, because the context plugin finds each repo's docs by itself (see [Project context](project-context.md)).
84
+
85
+ The install is non-destructive. A manifest (`.geneseed-manifest.json`) records the files Geneseed owns. A rebuild replaces and prunes only those files, and never touches your own agents, skills, plugins or memory.
86
+
87
+ ### OpenCode, per repo
88
+
89
+ ```
90
+ geneseed build --emit opencode --out /path/to/repo --root /path/to/repo
91
+ ```
92
+
93
+ This writes the bundle (`AGENT.md`, `agents/`, `skills/`, `memory/`, `notebook/`) and OpenCode's own layer (`opencode.json` and `.opencode/`) into one repository. You can commit them or not. To keep the bundle in a subfolder, point `--out` at the subfolder and keep `--root` on the repo, so instruction paths resolve from the project root:
94
+
95
+ ```
96
+ geneseed build --emit opencode --out /path/to/repo/Harness --root /path/to/repo
97
+ ```
98
+
99
+ ### Claude Code
100
+
101
+ ```
102
+ geneseed build --emit claude-global # ~/.claude, every repo
103
+ geneseed build --emit claude --out /path/to/repo --root /path/to/repo # one repo
104
+ ```
105
+
106
+ The install writes `CLAUDE.md`, `agents/`, `skills/`, `memory/` and `notebook/`, plus hooks in Claude Code's `settings.json`. Hooks are commands Claude Code runs around each tool call. They gate risky actions and load project context (see [Hooks](../concepts/hooks.md)). For a project install the hooks go into `.claude/settings.local.json`, which stays out of git because it names a path on your machine.
107
+
108
+ Every hook calls `geneseed-hook <verb>` through one stable file, the **hook shim** at `~/.geneseed/bin/geneseed-hook` (`geneseed-hook.cmd` on Windows). The shim knows where Node and Geneseed live. If you move or replace Geneseed, one rebuild rewrites the shim and every install works again. `GENESEED_HOME` moves the shim's folder.
109
+
110
+ ### OpenClaude
111
+
112
+ ```
113
+ geneseed build --emit openclaude-global # ~/.openclaude
114
+ geneseed build --emit openclaude --out /path/to/repo --root /path/to/repo # one repo
115
+ ```
116
+
117
+ [OpenClaude](https://openclaude.gitlawb.com/) is a fork of Claude Code that can drive any model. You get the same agents, skills and hooks as Claude Code, under a different config directory. OpenClaude never reads `~/.claude` or a project `.claude/`, so the two installs can sit side by side. The differences:
118
+
119
+ - Per repo, the preamble is written to `.openclaude/CLAUDE.md` rather than a root file, and the hooks go into `.openclaude/settings.local.json`.
120
+ - `$OPENCLAUDE_CONFIG_DIR` moves the global directory (default `~/.openclaude`).
121
+
122
+ OpenClaude support has not yet been verified against a live install.
123
+
124
+ ### IBM Bob
125
+
126
+ ```
127
+ geneseed build --emit bob-global # ~/.bob
128
+ geneseed build --emit bob --out /path/to/repo --root /path/to/repo # one repo
129
+ ```
130
+
131
+ Bob is shaped like Claude Code, so it gets the same agents and skills. Per repo, the preamble goes into a root `AGENTS.md` and the rest into `.bob/`. Globally, everything goes under `~/.bob` (`$BOB_CONFIG_DIR` moves it), and the preamble rides `rules/geneseed.md`, because Bob does not auto-load a global `AGENTS.md`. Bob's hooks refuse an action with exit code 2, and Bob has no `SubagentStop` or `PreCompact` events. Bob support has not yet been verified against a live install.
132
+
133
+ ### Any AGENT.md tool
134
+
135
+ ```
136
+ geneseed build # renders the plain bundle into ./Harness
137
+ ```
138
+
139
+ Point your tool's instructions or rules setting at `Harness/AGENT.md`. If the tool only loads one specific filename, rename or symlink the file (`AGENT.md` to `AGENTS.md` or `CLAUDE.md`). The rules then rest on the agent's own discipline, because these tools have no hooks or plugins to enforce anything (see [Enforced vs. asked](../understand/enforced-vs-asked.md)).
140
+
141
+ Some of these tools also load skills. Their own docs list where:
142
+
143
+ - **Codex CLI** loads a root `AGENTS.md` and `~/.codex/AGENTS.md`, and skills from `~/.codex/skills` or `.agents/skills`.
144
+ - **Cursor** loads `AGENTS.md`, and skills from `.cursor/skills`, `.agents/skills` or `.claude/skills`.
145
+ - **Gemini CLI** reads `GEMINI.md` by default. Set `context.fileName` in its `settings.json` to include `AGENTS.md`. Skills load from `.gemini/skills` or `.agents/skills`.
146
+
147
+ Copy or symlink the bundle's `skills/` to `.agents/skills/` and all three of them see it.
148
+
149
+ ### No runtime on the target machine
150
+
151
+ If the machine that will use the harness cannot run Node, run this once on a machine that can:
152
+
153
+ ```
154
+ npx geneseed prompt --theme neutral > install-geneseed.md
155
+ ```
156
+
157
+ This produces one self-contained prompt that recreates the whole file tree. Paste it into any capable agent on the target machine. There is nothing to install and no build step. Any theme works the same way.
158
+
159
+ ---
160
+
161
+ **Next:** [Verify it works](verify.md) · [Choose your setup](choose-your-setup.md) · [What lands on your machine](../understand/on-your-machine.md)