@litfamily/litcodex 1.0.4 → 1.0.5

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 (83) hide show
  1. package/README.md +114 -75
  2. package/dist/cli-model-route.js +27 -27
  3. package/dist/cli.js +6 -4
  4. package/dist/config-migration/catalog.d.ts +40 -1
  5. package/dist/config-migration/catalog.js +202 -57
  6. package/dist/config-migration/cli.d.ts +2 -1
  7. package/dist/config-migration/cli.js +34 -32
  8. package/dist/config-migration/gpt56-policy.d.ts +19 -10
  9. package/dist/config-migration/gpt56-policy.js +92 -50
  10. package/dist/config-migration/index.d.ts +2 -0
  11. package/dist/config-migration/index.js +28 -10
  12. package/dist/install/doctor-config.js +5 -5
  13. package/dist/install/doctor-render.js +16 -16
  14. package/dist/install/doctor.js +2 -2
  15. package/dist/install/execute.js +5 -4
  16. package/dist/install/generated-skill-payload-hashes.d.ts +30 -3
  17. package/dist/install/generated-skill-payload-hashes.js +30 -3
  18. package/dist/install/host-capabilities.d.ts +3 -4
  19. package/dist/install/host-capabilities.js +17 -19
  20. package/dist/install/install-model-prompt.js +44 -26
  21. package/dist/install/install-options.js +41 -46
  22. package/dist/install/install-presentation.js +2 -1
  23. package/dist/install/skill-catalog.d.ts +1 -1
  24. package/dist/install/skill-catalog.js +6 -1
  25. package/dist/install/skill-resource-hashes.d.ts +1 -1
  26. package/dist/install/skill-resource-hashes.js +1 -1
  27. package/dist/install/uninstall.js +6 -7
  28. package/marketplace/plugins/litcodex/.codex-plugin/plugin.json +1 -1
  29. package/marketplace/plugins/litcodex/components/auto-update/package.json +1 -1
  30. package/marketplace/plugins/litcodex/components/comment-checker/package.json +1 -1
  31. package/marketplace/plugins/litcodex/components/git-bash/package.json +1 -1
  32. package/marketplace/plugins/litcodex/components/lit-loop/agents/litcodex-default.toml +1 -1
  33. package/marketplace/plugins/litcodex/components/lit-loop/agents/litcodex-explorer.toml +1 -1
  34. package/marketplace/plugins/litcodex/components/lit-loop/agents/litcodex-librarian.toml +1 -1
  35. package/marketplace/plugins/litcodex/components/lit-loop/agents/litcodex-metis.toml +1 -1
  36. package/marketplace/plugins/litcodex/components/lit-loop/directives/litwork.md +1 -1
  37. package/marketplace/plugins/litcodex/components/lit-loop/package.json +1 -1
  38. package/marketplace/plugins/litcodex/components/lsp/package.json +1 -1
  39. package/marketplace/plugins/litcodex/components/rules/dist/model-metadata.d.ts +2 -1
  40. package/marketplace/plugins/litcodex/components/rules/dist/model-metadata.js +9 -1
  41. package/marketplace/plugins/litcodex/components/rules/package.json +1 -1
  42. package/marketplace/plugins/litcodex/components/start-work-continuation/package.json +1 -1
  43. package/marketplace/plugins/litcodex/components/telemetry/package.json +1 -1
  44. package/marketplace/plugins/litcodex/components/wikify-knowledge/package.json +1 -1
  45. package/marketplace/plugins/litcodex/skills/frontend-ui-ux/SKILL.md +22 -19
  46. package/marketplace/plugins/litcodex/skills/frontend-ui-ux/references/canonical-library.md +7 -1
  47. package/marketplace/plugins/litcodex/skills/frontend-ui-ux/references/complete-contract.md +17 -11
  48. package/marketplace/plugins/litcodex/skills/frontend-ui-ux/references/default-editorial-pixel.json +64 -0
  49. package/marketplace/plugins/litcodex/skills/frontend-ui-ux/references/production-interview.md +25 -0
  50. package/marketplace/plugins/litcodex/skills/readme-studio/SKILL.md +94 -0
  51. package/marketplace/plugins/litcodex/skills/readme-studio/references/decoration-patterns.md +36 -0
  52. package/marketplace/plugins/litcodex/skills/readme-studio/references/facts-and-assembly.md +36 -0
  53. package/marketplace/plugins/litcodex/skills/readme-studio/references/motion-and-delivery.md +47 -0
  54. package/marketplace/plugins/litcodex/skills/readme-studio/references/typography-and-imagery.md +34 -0
  55. package/marketplace/plugins/litcodex/skills/readme-studio/scripts/validate-readme-facts.mjs +130 -0
  56. package/marketplace/plugins/litcodex/skills/readme-studio/templates/cover-source.json +35 -0
  57. package/marketplace/plugins/litcodex/skills/readme-studio/templates/hyperframes-cover/index.html +61 -0
  58. package/marketplace/plugins/litcodex/skills/readme-studio/templates/hyperframes-cover/index.motion.json +6 -0
  59. package/marketplace/plugins/litcodex/skills/readme-studio/templates/hyperframes-cover/package-lock.json +1969 -0
  60. package/marketplace/plugins/litcodex/skills/readme-studio/templates/hyperframes-cover/package.json +14 -0
  61. package/marketplace/plugins/litcodex/skills/readme-studio/templates/readme-cover-section.md +85 -0
  62. package/marketplace/plugins/litcodex/skills/readme-studio/templates/readme-facts.json +11 -0
  63. package/marketplace/plugins/litcodex/skills/readme-studio/templates/remotion-cover/package-lock.json +3783 -0
  64. package/marketplace/plugins/litcodex/skills/readme-studio/templates/remotion-cover/package.json +15 -0
  65. package/marketplace/plugins/litcodex/skills/readme-studio/templates/remotion-cover/src/ReadmeCover.tsx +102 -0
  66. package/marketplace/plugins/litcodex/skills/readme-studio/templates/remotion-cover/src/Root.tsx +48 -0
  67. package/marketplace/plugins/litcodex/skills/readme-studio/templates/remotion-cover/src/index.tsx +4 -0
  68. package/marketplace/plugins/litcodex/skills/readme-studio/templates/remotion-cover/src/layout.ts +35 -0
  69. package/marketplace/plugins/litcodex/skills/readme-studio/templates/remotion-cover/src/motion.ts +25 -0
  70. package/marketplace/plugins/litcodex/skills/readme-studio/templates/typography/package-lock.json +133 -0
  71. package/marketplace/plugins/litcodex/skills/readme-studio/templates/typography/package.json +8 -0
  72. package/marketplace/plugins/litcodex/skills/readme-studio/templates/typography/shape-text-to-svg.mjs +238 -0
  73. package/model-catalog.json +163 -4
  74. package/node_modules/@litcodex/lit-loop/agents/litcodex-default.toml +1 -1
  75. package/node_modules/@litcodex/lit-loop/agents/litcodex-explorer.toml +1 -1
  76. package/node_modules/@litcodex/lit-loop/agents/litcodex-librarian.toml +1 -1
  77. package/node_modules/@litcodex/lit-loop/agents/litcodex-metis.toml +1 -1
  78. package/node_modules/@litcodex/lit-loop/directives/litwork.md +1 -1
  79. package/node_modules/@litcodex/lit-loop/package.json +1 -1
  80. package/package.json +2 -2
  81. package/readme-assets/badge-version.svg +1 -1
  82. package/readme-assets/cover-motion-still.webp +0 -0
  83. package/readme-assets/litfamily-machines.png +0 -0
package/README.md CHANGED
@@ -1,7 +1,7 @@
1
- <p align="center"><picture><source media="(prefers-reduced-motion: reduce)" srcset="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.4/readme-assets/cover.webp" /><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.4/readme-assets/cover-motion.webp" width="100%" alt="LitCodex cover art. An orange signal moves through orbital paths above the CODEX CLI wordmark. The static family cover appears for reduced-motion preference." /></picture></p>
2
- <p align="center"><a href="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.4/readme-assets/cover.webp">View the static cover</a></p>
1
+ <p align="center"><picture><source media="(prefers-reduced-motion: reduce)" srcset="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.5/readme-assets/cover-motion-still.webp" /><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.5/readme-assets/cover-motion.webp" width="100%" alt="LitCodex cover art. An orange signal crosses orbital paths above the CODEX CLI wordmark; a still frame from this cover appears when reduced motion is preferred." /></picture></p>
2
+ <p align="center"><a href="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.5/readme-assets/cover.webp">View the static cover</a></p>
3
3
 
4
- <p align="center"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.4/readme-assets/ascii-readme.svg" width="480" alt="LIT ASCII B mark" /></p>
4
+ <p align="center"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.5/readme-assets/ascii-readme.svg" width="480" alt="LIT ASCII B mark" /></p>
5
5
 
6
6
  <details>
7
7
  <summary>Copy ASCII logo</summary>
@@ -32,92 +32,46 @@ LIT · codex
32
32
 
33
33
  </details>
34
34
 
35
+ <p align="center"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.5/readme-assets/litcodex-wordmark.svg" width="480" alt="LITCODEX display type" /></p>
36
+ <p align="center"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.5/readme-assets/clay-icon.png" width="160" alt="LitCodex clay mark" /></p>
37
+
35
38
  <p align="center">
36
- <a href="#install"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.4/readme-assets/badge-version.svg" alt="1.0.4" /></a>
37
- <a href="https://github.com/wjgoarxiv/litcodex/blob/main/LICENSE"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.4/readme-assets/badge-license.svg" alt="MIT license" /></a>
39
+ <a href="#install"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.5/readme-assets/badge-version.svg" alt="1.0.5" /></a>
40
+ <a href="https://github.com/wjgoarxiv/litcodex/blob/main/LICENSE"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.5/readme-assets/badge-license.svg" alt="MIT license" /></a>
38
41
  </p>
39
42
 
40
43
  <p align="center">
41
- <a href="https://github.com/wjgoarxiv/litcodex/blob/main/docs/usage.md"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.4/readme-assets/lucide-book-open.svg" width="16" alt="" /> Docs</a> &nbsp; <a href="#install">Install</a> &nbsp; <a href="https://github.com/wjgoarxiv/litcodex/blob/main/docs/assets/readme/ignition-film.mp4"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.4/readme-assets/lucide-play.svg" width="16" alt="" /> Ignition</a> &nbsp; <a href="https://github.com/wjgoarxiv/litcodex/blob/main/LICENSE"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.4/readme-assets/lucide-shield-check.svg" width="16" alt="" /> MIT</a>
44
+ <a href="https://github.com/wjgoarxiv/litcodex/blob/main/docs/usage.md"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.5/readme-assets/lucide-book-open.svg" width="16" alt="" /> Docs</a> &nbsp; <a href="#install">Install</a> &nbsp; <a href="https://github.com/wjgoarxiv/litcodex/blob/main/docs/assets/readme/ignition-film.mp4"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.5/readme-assets/lucide-play.svg" width="16" alt="" /> Ignition</a> &nbsp; <a href="https://github.com/wjgoarxiv/litcodex/blob/main/LICENSE"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.5/readme-assets/lucide-shield-check.svg" width="16" alt="" /> MIT</a>
42
45
  </p>
43
46
 
44
47
  # @litfamily/litcodex
45
48
 
46
49
  **Keep the work lit.**
47
50
 
48
- **You have been handed a spark.<br>
49
- Bring it to the work you want to finish.**
50
-
51
- A bug to fix. A screen to build. A project to finish.
52
-
53
- Starting takes a sentence. Picking up where you left off takes more: the decisions you made,
54
- the checks you ran, and the next thing to try.
55
-
56
- **LIT keeps that spark with your project.** Goals, plans, checked results, and next steps stay in
57
- local records that a later session can read. An enduring spark means work you can return to;
58
- it is not a promise that an agent runs forever.
59
-
60
- **Where one conversation ends, the next stretch of work can begin.**
61
-
62
- Plan, execute, and verify work in Codex CLI. Type `lit` to keep goals, checks, and evidence with your project.
63
-
64
- The source tree retains `docs/assets/cover.svg` as the editable, low-bandwidth vector fallback; the WebP above is the README cover.
65
-
66
- [한국어](https://github.com/wjgoarxiv/litcodex/blob/main/README-Ko-KR.md) · [Install](#install) · [First lit](#activate-lit) · [Commands](#commands) · [Documentation](#documentation)
67
-
68
- ## Start with one lit task
69
-
70
- Append `lit` to a prompt to activate the Codex CLI hook. It routes the request into the durable loop; Codex still owns model execution.
71
-
72
- | Prompt or route | Effect |
73
- | --- | --- |
74
- | `lit` | Start a bounded task with goals and checks in the project. |
75
- | `handoff` or `/lit-handoff` | Carry the checked result and next step to another session. |
76
- | `lit-plan` | Prepare a plan and success criteria before editing. |
77
- | `lit start work <approved-plan>` | Execute an approved plan. |
78
- | `review-work` | Review the change and its evidence. |
79
- | `litresearch` | Record source-backed research and uncertainty. |
80
-
81
- The hook is an entry signal; it does not prove that a model result or visual check completed.
82
-
83
- <p align="center"><a href="https://github.com/wjgoarxiv/litcodex/blob/main/docs/assets/readme/ignition-film.mp4"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.4/readme-assets/ignition-poster.png" width="720" alt="Ignition motion poster" /></a></p>
84
-
85
- Select the poster for the optional film; this README keeps motion opt-in.
86
-
87
- ## Practical routes and visual cues
88
-
89
- Use `lit` to start a bounded task, `handoff` or `/lit-handoff` to carry checked work forward,
90
- `lit-plan` to set criteria before editing, `lit start work <approved-plan>` to execute an approved
91
- plan, `review-work` to inspect the change, and `litresearch` to record sources and uncertainty. Each
92
- route keeps its expected effect in project-local records; no new slash route is introduced here.
93
- Host limit: Codex CLI owns hook and agent execution, while authentication, model access, permissions,
94
- and any visual check remain host capabilities. A route mark or static editorial image is not completion
95
- evidence.
96
-
97
- <p align="center"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.4/readme-assets/litcodex-ignition-1600.webp" width="49%" alt="LitCodex ignition editorial cue" /> <img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.4/readme-assets/litcodex-continuity-1600.webp" width="49%" alt="LitCodex continuity editorial cue" /></p>
51
+ [한국어](https://github.com/wjgoarxiv/litcodex/blob/main/README-Ko-KR.md) · [Install](#install) · [Quick start](#activate-lit) · [Key features](#key-features) · [Commands](#commands) · [Troubleshooting](#troubleshooting) · [Links](#links)
98
52
 
99
53
  ## What is LitCodex
100
54
 
101
- LitCodex adds planning, review, research, and a durable execution loop to Codex CLI. Its `UserPromptSubmit`
102
- hook routes your request into the right discipline; the bundled library provides 38 skills. A goal is complete
103
- only after every success criterion passes. The npm package is self-contained and installs without a GitHub clone.
55
+ LitCodex adds planning, review, research, and a durable execution loop to Codex CLI.
104
56
 
105
57
  ## Install
106
58
 
107
- > Install `@litfamily/litcodex@1.0.4` with the scoped command below. See [migration guidance](https://github.com/wjgoarxiv/litcodex/blob/main/docs/npm-migration.md).
59
+ > Install `@litfamily/litcodex@1.0.5` with the scoped command below. See [migration guidance](https://github.com/wjgoarxiv/litcodex/blob/main/docs/npm-migration.md).
108
60
 
109
61
  With **Node.js 22+** and **Codex CLI** installed, run:
110
62
 
111
63
  ```sh
112
- npm exec --yes --package @litfamily/litcodex@1.0.4 -- litcodex install
64
+ npm exec --yes --package @litfamily/litcodex@1.0.5 -- litcodex install
113
65
  ```
114
66
 
115
67
  The installer registers the plugin, hooks, and agents, then updates managed keys in `~/.codex/config.toml`.
116
68
  It asks for the lead model, helper model, and output style. Codex authentication and model access are required
117
69
  when you run model work; installation itself does not require GitHub credentials.
118
70
 
119
- Preview changes with `npm exec --yes --package @litfamily/litcodex@1.0.4 -- litcodex --dry-run install`. For unattended setup, use
120
- `npm exec --yes --package @litfamily/litcodex@1.0.4 -- litcodex install --yes`. An explicit `--style <id>` still applies.
71
+ Fresh installs default to `gpt-6-astra` at `xhigh` for the lead route and `gpt-6-luna` at `max` for ordinary helpers. The installer also accepts supported model and effort choices.
72
+
73
+ Preview changes with `npm exec --yes --package @litfamily/litcodex@1.0.5 -- litcodex --dry-run install`. For unattended setup, use
74
+ `npm exec --yes --package @litfamily/litcodex@1.0.5 -- litcodex install --yes`. An explicit `--style <id>` still applies.
121
75
 
122
76
  For a persistent command:
123
77
 
@@ -126,7 +80,7 @@ npm install -g @litfamily/litcodex
126
80
  litcodex install
127
81
  ```
128
82
 
129
- > Without a global install, use `npm exec --yes --package @litfamily/litcodex@1.0.4 -- litcodex <command>`, such as `npm exec --yes --package @litfamily/litcodex@1.0.4 -- litcodex doctor`.
83
+ > Without a global install, use `npm exec --yes --package @litfamily/litcodex@1.0.5 -- litcodex <command>`, such as `npm exec --yes --package @litfamily/litcodex@1.0.5 -- litcodex doctor`.
130
84
 
131
85
  For an isolated trial apart from existing settings, follow the [isolated trial guide](https://github.com/wjgoarxiv/litcodex/blob/main/docs/npm-migration.md#isolated-local-trial).
132
86
  Changing only `CODEX_HOME` can still discover settings in your existing home.
@@ -143,7 +97,7 @@ lit add input validation to the signup form
143
97
  ```
144
98
 
145
99
  A bare `lit` selects `<lit-loop-mode>`. The hook emits the same plain-text, five-row activation mark
146
- in `UserPromptSubmit`'s `systemMessage` regardless of terminal color settings. The reply begins with
100
+ through `UserPromptSubmit`'s `systemMessage` regardless of terminal color settings. The reply begins with
147
101
  `🔥 **LIT IGNITED · <discipline>** 🔥`. `split`, `literal`, and `litmus` stay inert.
148
102
  Code spans and fences are ignored; slash-command-style mentions are ignored except the explicit `/litresearch` research route.
149
103
 
@@ -175,8 +129,83 @@ to read that packet and the project goals before continuing.
175
129
  Native Codex goals and the local loop ledger have separate boundaries. A paused or blocked native
176
130
  goal needs the documented recovery step below; a handoff does not silently resume it.
177
131
 
132
+ ## Key features
133
+
134
+ **You have been handed a spark.<br>
135
+ Bring it to the work you want to finish.**
136
+
137
+ A bug to fix. A screen to build. A project to finish.
138
+
139
+ Starting takes a sentence. Picking up where you left off takes more: the decisions you made,
140
+ the checks you ran, and the next thing to try.
141
+
142
+ **LIT keeps that spark with your project.** Goals, plans, checked results, and next steps stay in
143
+ local records that a later session can read. An enduring spark means work you can return to;
144
+ it is not a promise that an agent runs forever.
145
+
146
+ **Where one conversation ends, the next stretch of work can begin.**
147
+
148
+ Plan, execute, and verify work in Codex CLI. Type `lit` to keep goals, checks, and evidence with your project.
149
+
150
+ Its `UserPromptSubmit`
151
+ hook routes your request into the right discipline; the bundled library provides 38 skills. A goal is complete
152
+ only after every success criterion passes. The npm package is self-contained and installs without a GitHub clone.
153
+
154
+ Use `lit` to start a bounded task, `handoff` or `/lit-handoff` to carry checked work forward,
155
+ `lit-plan` to set criteria before editing, `lit start work <approved-plan>` to execute an approved
156
+ plan, `review-work` to inspect the change, and `litresearch` to record sources and uncertainty. Each
157
+ route keeps its expected effect in project-local records; no new slash route is introduced here.
158
+ Host limit: Codex CLI owns hook and agent execution, while authentication, model access, permissions,
159
+ and any visual check remain host capabilities. A route mark or static editorial image is not completion
160
+ evidence.
161
+
162
+ <p align="center"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.5/readme-assets/litcodex-ignition-1600.webp" width="49%" alt="LitCodex ignition editorial cue" /> <img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.5/readme-assets/litcodex-continuity-1600.webp" width="49%" alt="LitCodex continuity editorial cue" /></p>
163
+
164
+ ### How it fits together
165
+
166
+ Codex hosts the plugin and runs its hooks. The hooks supply routing and context; skills guide the
167
+ agent's work. The loop CLI keeps project records and prints instructions for native goal tools.
168
+
169
+ ```mermaid
170
+ flowchart TD
171
+ P["Installed LitCodex plugin"] --> H["Codex hooks: UserPromptSubmit and lifecycle"]
172
+ P --> S["Bundled skills"]
173
+ U["Your request in Codex"] --> H
174
+ H --> A["Codex agent"]
175
+ S --> A
176
+ A --> L["lit-loop CLI: goals, evidence, checkpoints"]
177
+ L --> R["Project records: .litcodex/lit-loop/"]
178
+ L -. "goal instructions" .-> A
179
+ A -. "native tools, when available" .-> G["Codex native /goal"]
180
+ R -. "read when continuing" .-> A
181
+ ```
182
+
183
+ The dotted native-goal connection is an agent protocol: the package does not call native goal tools
184
+ itself. When those tools are unavailable, keep the local records and report that native goal sync
185
+ was unavailable. A paused or blocked goal needs the documented recovery step; reading a handoff
186
+ does not automatically resume it. [Runtime and state reference](https://github.com/wjgoarxiv/litcodex/blob/main/docs/usage.md).
187
+
178
188
  ## Commands
179
189
 
190
+ ### Start with one lit task
191
+
192
+ Append `lit` to a prompt to activate the Codex CLI hook. It routes the request into the durable loop; Codex still owns model execution.
193
+
194
+ | Prompt or route | Effect |
195
+ | --- | --- |
196
+ | `lit` | Start a bounded task with goals and checks in the project. |
197
+ | `handoff` or `/lit-handoff` | Carry the checked result and next step to another session. |
198
+ | `lit-plan` | Prepare a plan and success criteria before editing. |
199
+ | `lit start work <approved-plan>` | Execute an approved plan. |
200
+ | `review-work` | Review the change and its evidence. |
201
+ | `litresearch` | Record source-backed research and uncertainty. |
202
+
203
+ The hook is an entry signal; it does not prove that a model result or visual check completed.
204
+
205
+ <p align="center"><a href="https://github.com/wjgoarxiv/litcodex/blob/main/docs/assets/readme/ignition-film.mp4"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.5/readme-assets/ignition-poster.png" width="720" alt="Ignition motion poster" /></a></p>
206
+
207
+ Select the poster for the optional film; this README keeps motion opt-in.
208
+
180
209
  ### In the Codex composer
181
210
 
182
211
  | Type this | Mode | What it does |
@@ -226,7 +255,7 @@ See [state and recovery](https://github.com/wjgoarxiv/litcodex/blob/main/docs/us
226
255
  ## Verify it worked
227
256
 
228
257
  ```sh
229
- npm exec --yes --package @litfamily/litcodex@1.0.4 -- litcodex doctor
258
+ npm exec --yes --package @litfamily/litcodex@1.0.5 -- litcodex doctor
230
259
  ```
231
260
 
232
261
  `litcodex doctor` checks registration, hooks, config, and host capabilities. `litcodex loop doctor` checks
@@ -257,12 +286,18 @@ project loop state. A successful installation check does not prove authenticated
257
286
  ## Uninstall
258
287
 
259
288
  ```sh
260
- npm exec --yes --package @litfamily/litcodex@1.0.4 -- litcodex uninstall
289
+ npm exec --yes --package @litfamily/litcodex@1.0.5 -- litcodex uninstall
261
290
  ```
262
291
 
263
292
  `litcodex uninstall` removes the plugin and LitCodex-managed config while preserving unrelated settings.
264
293
 
265
- ## Documentation
294
+ ## License
295
+
296
+ MIT
297
+
298
+ ## Links
299
+
300
+ ### Documentation
266
301
 
267
302
  - [Usage reference](https://github.com/wjgoarxiv/litcodex/blob/main/docs/usage.md) — complete routes, model configuration, platform limits, and recovery.
268
303
  - [LitCodex contract](https://github.com/wjgoarxiv/litcodex/blob/main/docs/spec/litcodex-contract.md) — hooks, native goal boundaries, and evidence requirements.
@@ -272,20 +307,24 @@ npm exec --yes --package @litfamily/litcodex@1.0.4 -- litcodex uninstall
272
307
  The bundled skill library also includes `autoconference`, `autoresearch`, `browser-drive`, `coding-session-audit`,
273
308
  `comment-checker`, `debugging`, `frontend-ui-ux`, `lit-commit`, `lit-crucible`, `lit-init`, `lit-korean`, `lit-fetch`,
274
309
  `litcodex-contribute-bug-fix`, `litcodex-doctor`, `litcodex-report-bug`, `lsp`, `lsp-setup`, `lit-code`, `refactor`,
275
- `lit-burnoff`, `structural-search`, `lit-team`, `visual-qa`, and `wikify`.
310
+ `lit-burnoff`, `readme-studio`, `structural-search`, `lit-team`, `visual-qa`, and `wikify`.
276
311
 
277
312
  Tests, fixtures, test helpers, and Vitest configuration remain tracked repository coverage and are excluded from npm and installed marketplace payloads.
278
313
 
279
314
  [Contributing](https://github.com/wjgoarxiv/litcodex/blob/main/CONTRIBUTING.md) · [Security](https://github.com/wjgoarxiv/litcodex/blob/main/SECURITY.md) · [Code of conduct](https://github.com/wjgoarxiv/litcodex/blob/main/CODE_OF_CONDUCT.md) · [Support](https://github.com/wjgoarxiv/litcodex/blob/main/SUPPORT.md) · [Privacy](https://github.com/wjgoarxiv/litcodex/blob/main/docs/privacy.md)
280
315
 
281
- ## Ignition motion
316
+ ### LITFAMILY
282
317
 
283
- Select the poster to watch the 10-second film.
318
+ ![LITFAMILY editorial illustration with five armored machines against a dark background](https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.5/readme-assets/litfamily-machines.png)
284
319
 
285
- <p align="center"><a href="https://github.com/wjgoarxiv/litcodex/blob/main/docs/assets/readme/ignition-film.mp4"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.4/readme-assets/ignition-poster.png" width="720" alt="Ignition motion graphic poster" /></a></p>
320
+ Five armored machines, one for each product in the LIT family.
286
321
 
287
- [Animated GIF](https://github.com/wjgoarxiv/litcodex/blob/main/docs/assets/readme/ignition-readme.gif) · [Media and icon credits](https://github.com/wjgoarxiv/litcodex/blob/main/docs/assets/readme/README.md)
322
+ ![A robot crew beneath the words LITFAMILY and KEEP THE WORK LIT.](https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.5/readme-assets/cover.webp)
288
323
 
289
- ## License
324
+ ### Ignition motion
290
325
 
291
- MIT
326
+ Select the poster to watch the 10-second film.
327
+
328
+ <p align="center"><a href="https://github.com/wjgoarxiv/litcodex/blob/main/docs/assets/readme/ignition-film.mp4"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.5/readme-assets/ignition-poster.png" width="720" alt="Ignition motion graphic poster" /></a></p>
329
+
330
+ [Animated GIF](https://github.com/wjgoarxiv/litcodex/blob/main/docs/assets/readme/ignition-readme.gif) · [Media and icon credits](https://github.com/wjgoarxiv/litcodex/blob/main/docs/assets/readme/README.md)
@@ -1,47 +1,47 @@
1
+ import { canonicalModelId, FALLBACK_CATALOG, modelDefinition } from "./config-migration/catalog.js";
2
+ import { unsafeEffectiveRoute } from "./config-migration/gpt56-policy.js";
1
3
  /** Pure model-route readers used by the synchronous dry-run dispatcher. */
2
4
  export function readModelChoice(args) {
3
5
  if (!args.includes("--model"))
4
- return "astra";
6
+ return modelDefinition(FALLBACK_CATALOG.current.model)?.configProfile ?? "astra";
5
7
  const value = args[args.indexOf("--model") + 1];
6
- if (value === "gpt-6-astra" || value === "astra")
7
- return "astra";
8
- if (value === "sol" || value === "gpt-5.6")
9
- return "sol";
10
- if (value === "terra")
11
- return "terra";
12
- return "luna";
8
+ return modelDefinition(canonicalModelId(value))?.configProfile ?? readModelChoice([]);
13
9
  }
14
10
  export function readLeadModelChoice(args) {
15
- const value = args[args.indexOf("--model") + 1];
16
- if (value === "gpt-6-astra" || value === "astra")
17
- return "gpt-6-astra";
18
- if (value === "sol")
19
- return "gpt-5.6-sol";
20
- if (value === "gpt-5.6")
21
- return "gpt-5.6";
22
- return value === "terra" ? "gpt-5.6-terra" : value === "luna" ? "gpt-5.6-luna" : "gpt-6-astra";
11
+ if (!args.includes("--model"))
12
+ return FALLBACK_CATALOG.current.model;
13
+ return canonicalModelId(args[args.indexOf("--model") + 1]) ?? FALLBACK_CATALOG.current.model;
23
14
  }
24
15
  export function readSubagentModelChoice(args) {
25
- const value = args[args.indexOf("--subagent-model") + 1];
26
- if (value === "gpt-6-astra" || value === "astra")
27
- return "gpt-6-astra";
28
- if (value === "gpt-5.6")
29
- return "gpt-5.6";
30
- return value === "terra" ? "gpt-5.6-terra" : value === "luna" ? "gpt-5.6-luna" : "gpt-5.6-luna";
16
+ const defaultRoute = FALLBACK_CATALOG.roles["default"];
17
+ const defaultModel = defaultRoute?.model ?? FALLBACK_CATALOG.current.model;
18
+ if (!args.includes("--subagent-model"))
19
+ return defaultModel;
20
+ return canonicalModelId(args[args.indexOf("--subagent-model") + 1]) ?? defaultModel;
31
21
  }
32
22
  export function readSubagentEffortChoice(args) {
33
23
  const value = args[args.indexOf("--subagent-effort") + 1];
34
24
  const model = readSubagentModelChoice(args);
35
- return effortForModel(value, model, "max");
25
+ const defaultEffort = args.includes("--subagent-model")
26
+ ? modelDefinition(model)?.recommendedEffort
27
+ : FALLBACK_CATALOG.roles["default"]?.model_reasoning_effort;
28
+ return effortForModel(value, model, defaultEffort ?? modelDefinition(model)?.recommendedEffort ?? "max");
36
29
  }
37
30
  export function readEffortChoice(args) {
38
31
  const value = args[args.indexOf("--effort") + 1];
39
- return effortForModel(value, readLeadModelChoice(args), "xhigh");
32
+ const model = readLeadModelChoice(args);
33
+ const defaultEffort = args.includes("--model")
34
+ ? modelDefinition(model)?.recommendedEffort
35
+ : FALLBACK_CATALOG.current.model_reasoning_effort;
36
+ return effortForModel(value, model, defaultEffort ?? modelDefinition(model)?.recommendedEffort ?? "xhigh");
40
37
  }
41
38
  function effortForModel(value, model, fallback) {
42
- if (model === "gpt-6-astra" &&
43
- (value === "low" || value === "medium" || value === "high" || value === "xhigh" || value === "max")) {
39
+ const definition = modelDefinition(model);
40
+ if (definition !== undefined &&
41
+ value !== undefined &&
42
+ definition.configurableEfforts.includes(value) &&
43
+ unsafeEffectiveRoute({ model, model_reasoning_effort: value }) === null) {
44
44
  return value;
45
45
  }
46
- return value === "high" || value === "xhigh" || value === "max" ? value : fallback;
46
+ return fallback;
47
47
  }
package/dist/cli.js CHANGED
@@ -4,6 +4,7 @@
4
4
  import { createRequire } from "node:module";
5
5
  import { runForegroundAutoUpdate } from "./auto-update.js";
6
6
  import { readEffortChoice, readLeadModelChoice, readModelChoice, readSubagentEffortChoice, readSubagentModelChoice, } from "./cli-model-route.js";
7
+ import { acceptedModelIds, FALLBACK_CATALOG } from "./config-migration/catalog.js";
7
8
  import { runConfigMigrateCli } from "./config-migration/cli.js";
8
9
  import { resolveCodexHome } from "./install/codex.js";
9
10
  import { runDoctorCli, runInstallCli, runUninstallCli } from "./install/index.js";
@@ -74,6 +75,7 @@ function configRouteHandler(rest) {
74
75
  }
75
76
  const KNOWN_SUBCOMMANDS = Object.keys(ROUTES);
76
77
  function renderHelp() {
78
+ const modelIds = acceptedModelIds().join("|");
77
79
  return [
78
80
  "litcodex — self-contained LitCodex CLI for Codex",
79
81
  "",
@@ -89,10 +91,10 @@ function renderHelp() {
89
91
  " litcodex --version Show the @litfamily/litcodex version",
90
92
  "",
91
93
  "Install model options:",
92
- " --model <gpt-6-astra|sol|gpt-5.6|luna|terra> Select the LEAD model (default: gpt-6-astra)",
93
- " --effort <low|medium|high|xhigh|max> Select LEAD reasoning effort (Astra: all five)",
94
- " --subagent-model <gpt-6-astra|luna|gpt-5.6|terra> Select the helper route (default: luna)",
95
- " --subagent-effort <low|medium|high|xhigh|max> Select helper effort (Astra: all five)",
94
+ ` --model <${modelIds}> Select the LEAD model (default: ${FALLBACK_CATALOG.current.model})`,
95
+ " --effort <low|medium|high|xhigh|max|ultra> Select LEAD reasoning effort (catalog validated)",
96
+ ` --subagent-model <${modelIds}> Select the helper route (default: ${FALLBACK_CATALOG.roles["default"]?.model ?? FALLBACK_CATALOG.current.model})`,
97
+ " --subagent-effort <low|medium|high|xhigh|max|ultra> Select helper effort (catalog validated)",
96
98
  " --yes Keep defaults; never prompt",
97
99
  " --reconfigure Explicitly apply the choice to the root model/effort",
98
100
  " --no-auto-update Skip the foreground update barrier for this command",
@@ -1,3 +1,7 @@
1
+ export declare const REASONING_EFFORTS: readonly ["low", "medium", "high", "xhigh", "max", "ultra"];
2
+ export type ReasoningEffortId = (typeof REASONING_EFFORTS)[number];
3
+ export declare const MODEL_CONFIG_PROFILES: readonly ["astra", "sol", "terra", "luna"];
4
+ export type ModelConfigProfile = (typeof MODEL_CONFIG_PROFILES)[number];
1
5
  export interface ReasoningProfile {
2
6
  model: string;
3
7
  model_reasoning_effort: string;
@@ -11,13 +15,48 @@ export interface ManagedProfile {
11
15
  version: string;
12
16
  match: ProfileMatch;
13
17
  }
18
+ export interface ModelRetirement {
19
+ retirementAt: string;
20
+ upgradeModel: string;
21
+ }
22
+ export interface ModelDefinition {
23
+ id: string;
24
+ configProfile: ModelConfigProfile;
25
+ legacyProfile?: Exclude<ModelConfigProfile, "astra">;
26
+ contextProbe: boolean;
27
+ displayName: string;
28
+ generation: string;
29
+ priority: number;
30
+ visibility: "list";
31
+ supportedInApi: boolean;
32
+ speedTier: string;
33
+ aliases: readonly string[];
34
+ supportedEfforts: readonly ReasoningEffortId[];
35
+ configurableEfforts: readonly ReasoningEffortId[];
36
+ safeExistingEfforts?: readonly ReasoningEffortId[];
37
+ installerMenu: Readonly<{
38
+ lead: readonly ReasoningEffortId[];
39
+ helper: readonly ReasoningEffortId[];
40
+ }>;
41
+ defaultEffort: ReasoningEffortId;
42
+ recommendedRole: string;
43
+ recommendedEffort: ReasoningEffortId;
44
+ retirement?: ModelRetirement;
45
+ }
14
46
  export interface ModelCatalog {
15
47
  version: string;
16
48
  current: ReasoningProfile;
49
+ models: readonly ModelDefinition[];
17
50
  roles: Readonly<Record<string, Partial<ReasoningProfile>>>;
18
51
  managedProfiles: readonly ManagedProfile[];
19
52
  }
20
- /** Used whenever the on-disk catalog is missing, malformed, or schema-invalid. */
21
53
  export declare const FALLBACK_CATALOG: ModelCatalog;
22
54
  /** Read the catalog. Never throws — returns FALLBACK_CATALOG on any failure. */
23
55
  export declare function readModelCatalog(env?: NodeJS.ProcessEnv): Promise<ModelCatalog>;
56
+ /** Return the catalog definition for a canonical id or one of its aliases. */
57
+ export declare function modelDefinition(modelId: string | undefined, catalog?: ModelCatalog): ModelDefinition | undefined;
58
+ /** Return the canonical id for a user-supplied id or alias. */
59
+ export declare function canonicalModelId(modelId: string | undefined, catalog?: ModelCatalog): string | undefined;
60
+ /** All ids accepted by installer/config-migration boundaries, canonical ids first. */
61
+ export declare function acceptedModelIds(catalog?: ModelCatalog): readonly string[];
62
+ export declare function supportedEffortsForModel(modelId: string | undefined, catalog?: ModelCatalog): readonly ReasoningEffortId[];