@litfamily/litcodex 1.0.7 → 1.0.8
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.
- package/README.md +105 -71
- package/dist/install/doctor-render.js +1 -0
- package/dist/install/doctor.js +8 -0
- package/dist/install/types.d.ts +3 -0
- package/marketplace/plugins/litcodex/.codex-plugin/plugin.json +1 -1
- package/marketplace/plugins/litcodex/components/auto-update/package.json +1 -1
- package/marketplace/plugins/litcodex/components/comment-checker/package.json +1 -1
- package/marketplace/plugins/litcodex/components/git-bash/package.json +1 -1
- package/marketplace/plugins/litcodex/components/lit-loop/dist/hook-cli.d.ts +8 -1
- package/marketplace/plugins/litcodex/components/lit-loop/dist/hook-cli.js +36 -4
- package/marketplace/plugins/litcodex/components/lit-loop/dist/jev-hint.d.ts +112 -0
- package/marketplace/plugins/litcodex/components/lit-loop/dist/jev-hint.js +522 -0
- package/marketplace/plugins/litcodex/components/lit-loop/package.json +1 -1
- package/marketplace/plugins/litcodex/components/lsp/package.json +1 -1
- package/marketplace/plugins/litcodex/components/rules/package.json +1 -1
- package/marketplace/plugins/litcodex/components/start-work-continuation/package.json +1 -1
- package/marketplace/plugins/litcodex/components/telemetry/package.json +1 -1
- package/marketplace/plugins/litcodex/components/wikify-knowledge/package.json +1 -1
- package/node_modules/@litcodex/lit-loop/dist/hook-cli.d.ts +8 -1
- package/node_modules/@litcodex/lit-loop/dist/hook-cli.js +36 -4
- package/node_modules/@litcodex/lit-loop/dist/jev-hint.d.ts +112 -0
- package/node_modules/@litcodex/lit-loop/dist/jev-hint.js +522 -0
- package/node_modules/@litcodex/lit-loop/package.json +1 -1
- package/package.json +3 -3
- package/readme-assets/badge-version.svg +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
<p align="center"><picture><source media="(prefers-reduced-motion: reduce)" srcset="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
1
|
+
<p align="center"><picture><source media="(prefers-reduced-motion: reduce)" srcset="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/cover-motion-still.webp" /><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/cover-motion.webp" width="100%" alt="LitFamily motion cover: five armored robots power on one by one, the LitCodex robot wakes with glowing eyes and a lit frame, then LITFAMILY and KEEP THE WORK LIT. light up." /></picture></p>
|
|
2
2
|
|
|
3
|
-
<p align="center"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
3
|
+
<p align="center"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/ascii-readme.svg" width="480" alt="LIT ASCII B mark" /></p>
|
|
4
4
|
|
|
5
5
|
<details>
|
|
6
6
|
<summary>Copy ASCII logo</summary>
|
|
@@ -31,16 +31,16 @@ LIT · codex
|
|
|
31
31
|
|
|
32
32
|
</details>
|
|
33
33
|
|
|
34
|
-
<p align="center"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
35
|
-
<p align="center"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
34
|
+
<p align="center"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/litcodex-wordmark.svg" width="480" alt="LITCODEX display type" /></p>
|
|
35
|
+
<p align="center"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/clay-icon.png" width="160" alt="LitCodex clay mark" /></p>
|
|
36
36
|
|
|
37
37
|
<p align="center">
|
|
38
|
-
<a href="#install"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
39
|
-
<a href="https://github.com/wjgoarxiv/litcodex/blob/main/LICENSE"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
38
|
+
<a href="#install"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/badge-version.svg" alt="1.0.8" /></a>
|
|
39
|
+
<a href="https://github.com/wjgoarxiv/litcodex/blob/main/LICENSE"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/badge-license.svg" alt="MIT license" /></a>
|
|
40
40
|
</p>
|
|
41
41
|
|
|
42
42
|
<p align="center">
|
|
43
|
-
<a href="https://github.com/wjgoarxiv/litcodex/blob/main/docs/usage.md"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
43
|
+
<a href="https://github.com/wjgoarxiv/litcodex/blob/main/docs/usage.md"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/lucide-book-open.svg" width="16" alt="" /> Docs</a> <a href="#install">Install</a> <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.8/readme-assets/lucide-play.svg" width="16" alt="" /> Ignition</a> <a href="https://github.com/wjgoarxiv/litcodex/blob/main/LICENSE"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/lucide-shield-check.svg" width="16" alt="" /> MIT</a>
|
|
44
44
|
</p>
|
|
45
45
|
|
|
46
46
|
# @litfamily/litcodex
|
|
@@ -55,12 +55,12 @@ LitCodex adds planning, review, research, and a durable execution loop to Codex
|
|
|
55
55
|
|
|
56
56
|
## Install
|
|
57
57
|
|
|
58
|
-
> Install `@litfamily/litcodex@1.0.
|
|
58
|
+
> Install `@litfamily/litcodex@1.0.8` with the scoped command below. See [migration guidance](https://github.com/wjgoarxiv/litcodex/blob/main/docs/npm-migration.md).
|
|
59
59
|
|
|
60
60
|
With **Node.js 22+** and **Codex CLI** installed, run:
|
|
61
61
|
|
|
62
62
|
```sh
|
|
63
|
-
npm exec --yes --package @litfamily/litcodex@1.0.
|
|
63
|
+
npm exec --yes --package @litfamily/litcodex@1.0.8 -- litcodex install
|
|
64
64
|
```
|
|
65
65
|
|
|
66
66
|
The installer registers the plugin, hooks, and agents, then updates managed keys in `~/.codex/config.toml`.
|
|
@@ -69,8 +69,8 @@ when you run model work; installation itself does not require GitHub credentials
|
|
|
69
69
|
|
|
70
70
|
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.
|
|
71
71
|
|
|
72
|
-
Preview changes with `npm exec --yes --package @litfamily/litcodex@1.0.
|
|
73
|
-
`npm exec --yes --package @litfamily/litcodex@1.0.
|
|
72
|
+
Preview changes with `npm exec --yes --package @litfamily/litcodex@1.0.8 -- litcodex --dry-run install`. For unattended setup, use
|
|
73
|
+
`npm exec --yes --package @litfamily/litcodex@1.0.8 -- litcodex install --yes`. An explicit `--style <id>` still applies.
|
|
74
74
|
|
|
75
75
|
For a persistent command:
|
|
76
76
|
|
|
@@ -79,7 +79,7 @@ npm install -g @litfamily/litcodex
|
|
|
79
79
|
litcodex install
|
|
80
80
|
```
|
|
81
81
|
|
|
82
|
-
> Without a global install, use `npm exec --yes --package @litfamily/litcodex@1.0.
|
|
82
|
+
> Without a global install, use `npm exec --yes --package @litfamily/litcodex@1.0.8 -- litcodex <command>`, such as `npm exec --yes --package @litfamily/litcodex@1.0.8 -- litcodex doctor`.
|
|
83
83
|
|
|
84
84
|
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).
|
|
85
85
|
Changing only `CODEX_HOME` can still discover settings in your existing home.
|
|
@@ -158,7 +158,7 @@ Host limit: Codex CLI owns hook and agent execution, while authentication, model
|
|
|
158
158
|
and any visual check remain host capabilities. A route mark or static editorial image is not completion
|
|
159
159
|
evidence.
|
|
160
160
|
|
|
161
|
-
<p align="center"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
161
|
+
<p align="center"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/litcodex-ignition-1600.webp" width="49%" alt="LitCodex ignition editorial cue" /> <img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/litcodex-continuity-1600.webp" width="49%" alt="LitCodex continuity editorial cue" /></p>
|
|
162
162
|
|
|
163
163
|
### How it fits together
|
|
164
164
|
|
|
@@ -191,207 +191,207 @@ Each row is a skill you can start by name or route, with how to start it and wha
|
|
|
191
191
|
<table>
|
|
192
192
|
<tr><th>What it looks like</th><th>Skill</th><th>What you get</th></tr>
|
|
193
193
|
<tr>
|
|
194
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
194
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/lit-loop.webp" width="240" alt="Add lit to a request. Codex binds the scope, works with evidence and records what it could not verify." /></td>
|
|
195
195
|
<td><code>lit-loop</code><br /><sub><code>lit</code> · <code>$litcodex:lit-loop</code></sub></td>
|
|
196
196
|
<td>Add <code>lit</code> to a request. Codex binds the scope, works with evidence and records what it could not verify.</td>
|
|
197
197
|
</tr>
|
|
198
198
|
<tr>
|
|
199
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
199
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/litwork.webp" width="240" alt="Careful end-to-end build or fix: RED first, then proof on the real surface." /></td>
|
|
200
200
|
<td><code>litwork</code><br /><sub><code>litwork</code> · <code>$litcodex:litwork</code></sub></td>
|
|
201
201
|
<td>Careful end-to-end build or fix: RED first, then proof on the real surface.</td>
|
|
202
202
|
</tr>
|
|
203
203
|
<tr>
|
|
204
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
204
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/lit-plan.webp" width="240" alt="An approved plan in .litcodex/plans/ with numbered rows. Planning only." /></td>
|
|
205
205
|
<td><code>lit-plan</code><br /><sub><code>lit plan</code> · <code>$litcodex:lit-plan</code></sub></td>
|
|
206
206
|
<td>An approved plan in <code>.litcodex/plans/</code> with numbered rows. Planning only.</td>
|
|
207
207
|
</tr>
|
|
208
208
|
<tr>
|
|
209
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
209
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/start-approved-plan.webp" width="240" alt="Runs an approved plan through five gates. All five review lanes must pass at the end." /></td>
|
|
210
210
|
<td>Start Work<br /><sub><code>lit start work <approved-plan></code></sub></td>
|
|
211
211
|
<td>Runs an approved plan through five gates. All five review lanes must pass at the end.</td>
|
|
212
212
|
</tr>
|
|
213
213
|
<tr>
|
|
214
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
214
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/review-work.webp" width="240" alt="Five blocking review lanes. One failing lane blocks approval." /></td>
|
|
215
215
|
<td><code>review-work</code><br /><sub><code>lit review</code> · <code>$litcodex:review-work</code></sub></td>
|
|
216
216
|
<td>Five blocking review lanes. One failing lane blocks approval.</td>
|
|
217
217
|
</tr>
|
|
218
218
|
<tr>
|
|
219
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
219
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/litgoal.webp" width="240" alt="Binds one goal with observable criteria to the durable lit-loop." /></td>
|
|
220
220
|
<td><code>litgoal</code><br /><sub><code>lit goal</code> · <code>$litcodex:litgoal</code></sub></td>
|
|
221
221
|
<td>Binds one goal with observable criteria to the durable lit-loop.</td>
|
|
222
222
|
</tr>
|
|
223
223
|
<tr>
|
|
224
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
224
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/lit-recap.webp" width="240" alt="A read-only summary: done, in progress, blocked, where the evidence is, what comes next." /></td>
|
|
225
225
|
<td><code>lit-recap</code><br /><sub><code>lit recap</code> · <code>$litcodex:lit-recap</code></sub></td>
|
|
226
226
|
<td>A read-only summary: done, in progress, blocked, where the evidence is, what comes next.</td>
|
|
227
227
|
</tr>
|
|
228
228
|
<tr>
|
|
229
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
229
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/lit-handoff.webp" width="240" alt="Type handoff to get a continuation file the next session can read and resume from." /></td>
|
|
230
230
|
<td><code>lit-handoff</code><br /><sub><code>handoff</code> · <code>/lit-handoff</code></sub></td>
|
|
231
231
|
<td>Type <code>handoff</code> to get a continuation file the next session can read and resume from.</td>
|
|
232
232
|
</tr>
|
|
233
233
|
<tr>
|
|
234
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
234
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/deep-interview.webp" width="240" alt="One question at a time until the idea is clear enough to build. Quick, Standard and Deep set the target." /></td>
|
|
235
235
|
<td><code>deep-interview</code><br /><sub><code>deep-interview</code> · <code>$litcodex:deep-interview</code></sub></td>
|
|
236
236
|
<td>One question at a time until the idea is clear enough to build. Quick, Standard and Deep set the target.</td>
|
|
237
237
|
</tr>
|
|
238
238
|
<tr>
|
|
239
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
239
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/litresearch.webp" width="240" alt="Parallel evidence gathering and a cited synthesis, only when you ask for research." /></td>
|
|
240
240
|
<td><code>litresearch</code><br /><sub><code>lit research</code> · <code>$litcodex:litresearch</code></sub></td>
|
|
241
241
|
<td>Parallel evidence gathering and a cited synthesis, only when you ask for research.</td>
|
|
242
242
|
</tr>
|
|
243
243
|
<tr>
|
|
244
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
244
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/lit-crucible.webp" width="240" alt="Pressure-tests a brief before planning. Only the risks that survive critique reach the plan." /></td>
|
|
245
245
|
<td><code>lit-crucible</code><br /><sub><code>lit-crucible</code> · <code>$litcodex:lit-crucible</code></sub></td>
|
|
246
246
|
<td>Pressure-tests a brief before planning. Only the risks that survive critique reach the plan.</td>
|
|
247
247
|
</tr>
|
|
248
248
|
<tr>
|
|
249
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
249
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/lit-init.webp" width="240" alt="Sparse AGENTS.md guidance backed by what is in the repository." /></td>
|
|
250
250
|
<td><code>lit-init</code><br /><sub><code>lit-init</code> · <code>$litcodex:lit-init</code></sub></td>
|
|
251
251
|
<td>Sparse AGENTS.md guidance backed by what is in the repository.</td>
|
|
252
252
|
</tr>
|
|
253
253
|
<tr>
|
|
254
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
254
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/lit-comprehend.webp" width="240" alt="An explainer page for agent-written work: intuition first, then the walkthrough, then a short quiz." /></td>
|
|
255
255
|
<td><code>lit-comprehend</code><br /><sub><code>lit-comprehend</code> · <code>$litcodex:lit-comprehend</code></sub></td>
|
|
256
256
|
<td>An explainer page for agent-written work: intuition first, then the walkthrough, then a short quiz.</td>
|
|
257
257
|
</tr>
|
|
258
258
|
<tr>
|
|
259
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
259
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/lit-humanizer.webp" width="240" alt="Rewrites stiff model prose in English or Korean. Facts and hedges stay; filler goes." /></td>
|
|
260
260
|
<td><code>lit-humanizer</code><br /><sub><code>$litcodex:lit-humanizer</code></sub></td>
|
|
261
261
|
<td>Rewrites stiff model prose in English or Korean. Facts and hedges stay; filler goes.</td>
|
|
262
262
|
</tr>
|
|
263
263
|
<tr>
|
|
264
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
264
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/lit-diagram-drawer.webp" width="240" alt="A checked, editable diagram for slides and documents, with PNG and Office-safe SVG exports." /></td>
|
|
265
265
|
<td><code>lit-diagram-drawer</code><br /><sub><code>$litcodex:lit-diagram-drawer</code></sub></td>
|
|
266
266
|
<td>A checked, editable diagram for slides and documents, with PNG and Office-safe SVG exports.</td>
|
|
267
267
|
</tr>
|
|
268
268
|
<tr>
|
|
269
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
269
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/lit-pptx.webp" width="240" alt="Ask for slides with lit and get an editable PowerPoint deck with its Markdown source, AZURE-PRO and Pretendard by default. Layout QA runs on the file; rendered slides are inspected when LibreOffice is present." /></td>
|
|
270
270
|
<td><code>lit-pptx</code><br /><sub><code>$litcodex:lit-pptx</code></sub></td>
|
|
271
271
|
<td>Ask for slides with <code>lit</code> and get an editable PowerPoint deck with its Markdown source, AZURE-PRO and Pretendard by default. Layout QA runs on the file; rendered slides are inspected when LibreOffice is present.</td>
|
|
272
272
|
</tr>
|
|
273
273
|
<tr>
|
|
274
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
274
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/lit-docx.webp" width="240" alt="Ask for a report with lit and get a styled Word file with its Markdown source; Korean text uses korean-generic. The file is reopened and linted, and pages are inspected when LibreOffice is present." /></td>
|
|
275
275
|
<td><code>lit-docx</code><br /><sub><code>$litcodex:lit-docx</code></sub></td>
|
|
276
276
|
<td>Ask for a report with <code>lit</code> and get a styled Word file with its Markdown source; Korean text uses korean-generic. The file is reopened and linted, and pages are inspected when LibreOffice is present.</td>
|
|
277
277
|
</tr>
|
|
278
278
|
<tr>
|
|
279
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
279
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/lit-fetch.webp" width="240" alt="Reads a public page with URL, DNS and text-safety checks when ordinary retrieval falls short." /></td>
|
|
280
280
|
<td><code>lit-fetch</code><br /><sub><code>$litcodex:lit-fetch</code></sub></td>
|
|
281
281
|
<td>Reads a public page with URL, DNS and text-safety checks when ordinary retrieval falls short.</td>
|
|
282
282
|
</tr>
|
|
283
283
|
<tr>
|
|
284
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
284
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/lit-scientific-visualization.webp" width="240" alt="A journal-sized figure with vector and 600 DPI exports. The chart type follows the data." /></td>
|
|
285
285
|
<td><code>lit-scientific-visualization</code><br /><sub><code>lit-scientific-visualization</code> · <code>$litcodex:lit-scientific-visualization</code></sub></td>
|
|
286
286
|
<td>A journal-sized figure with vector and 600 DPI exports. The chart type follows the data.</td>
|
|
287
287
|
</tr>
|
|
288
288
|
<tr>
|
|
289
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
289
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/lit-team.webp" width="240" alt="Coordinates several workers with separate slices, each reporting back with evidence." /></td>
|
|
290
290
|
<td><code>lit-team</code><br /><sub><code>lit team</code> · <code>$litcodex:lit-team</code></sub></td>
|
|
291
291
|
<td>Coordinates several workers with separate slices, each reporting back with evidence.</td>
|
|
292
292
|
</tr>
|
|
293
293
|
<tr>
|
|
294
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
294
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/litcodex-doctor.webp" width="240" alt="Checks LitCodex and Codex install health after an update, drift or a failed setup." /></td>
|
|
295
295
|
<td><code>litcodex-doctor</code><br /><sub><code>$litcodex:litcodex-doctor</code></sub></td>
|
|
296
296
|
<td>Checks LitCodex and Codex install health after an update, drift or a failed setup.</td>
|
|
297
297
|
</tr>
|
|
298
298
|
<tr>
|
|
299
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
299
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/litcodex-report-bug.webp" width="240" alt="Drafts a bug report for LitCodex or Codex, backed by sources." /></td>
|
|
300
300
|
<td><code>litcodex-report-bug</code><br /><sub><code>$litcodex:litcodex-report-bug</code></sub></td>
|
|
301
301
|
<td>Drafts a bug report for LitCodex or Codex, backed by sources.</td>
|
|
302
302
|
</tr>
|
|
303
303
|
<tr>
|
|
304
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
304
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/litcodex-contribute-bug-fix.webp" width="240" alt="Turns a diagnosed defect into a tested bug-fix PR." /></td>
|
|
305
305
|
<td><code>litcodex-contribute-bug-fix</code><br /><sub><code>$litcodex:litcodex-contribute-bug-fix</code></sub></td>
|
|
306
306
|
<td>Turns a diagnosed defect into a tested bug-fix PR.</td>
|
|
307
307
|
</tr>
|
|
308
308
|
<tr>
|
|
309
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
309
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/coding-session-audit.webp" width="240" alt="Reads a past Codex session from its evidence and shows where it stopped." /></td>
|
|
310
310
|
<td><code>coding-session-audit</code><br /><sub><code>$litcodex:coding-session-audit</code></sub></td>
|
|
311
311
|
<td>Reads a past Codex session from its evidence and shows where it stopped.</td>
|
|
312
312
|
</tr>
|
|
313
313
|
<tr>
|
|
314
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
314
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/debugging.webp" width="240" alt="Reproduces the bug, tests at least three explanations, and fixes only the confirmed cause." /></td>
|
|
315
315
|
<td><code>debugging</code><br /><sub><code>$litcodex:debugging</code></sub></td>
|
|
316
316
|
<td>Reproduces the bug, tests at least three explanations, and fixes only the confirmed cause.</td>
|
|
317
317
|
</tr>
|
|
318
318
|
<tr>
|
|
319
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
319
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/refactor.webp" width="240" alt="Restructures code while tests pin its behavior before and after every step." /></td>
|
|
320
320
|
<td><code>refactor</code><br /><sub><code>$litcodex:refactor</code></sub></td>
|
|
321
321
|
<td>Restructures code while tests pin its behavior before and after every step.</td>
|
|
322
322
|
</tr>
|
|
323
323
|
<tr>
|
|
324
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
324
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/lit-code.webp" width="240" alt="Strict implementation rules: tests first, typed boundaries, small files." /></td>
|
|
325
325
|
<td><code>lit-code</code><br /><sub><code>$litcodex:lit-code</code></sub></td>
|
|
326
326
|
<td>Strict implementation rules: tests first, typed boundaries, small files.</td>
|
|
327
327
|
</tr>
|
|
328
328
|
<tr>
|
|
329
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
329
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/lit-commit.webp" width="240" alt="Splits your changes into atomic commits in the repo's own style and leaves unrelated work alone." /></td>
|
|
330
330
|
<td><code>lit-commit</code><br /><sub><code>$litcodex:lit-commit</code></sub></td>
|
|
331
331
|
<td>Splits your changes into atomic commits in the repo's own style and leaves unrelated work alone.</td>
|
|
332
332
|
</tr>
|
|
333
333
|
<tr>
|
|
334
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
334
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/lsp-setup.webp" width="240" alt="Checks language-server setup and runs a real diagnostics check on demand." /></td>
|
|
335
335
|
<td><code>lsp-setup</code><br /><sub><code>$litcodex:lsp-setup</code></sub></td>
|
|
336
336
|
<td>Checks language-server setup and runs a real diagnostics check on demand.</td>
|
|
337
337
|
</tr>
|
|
338
338
|
<tr>
|
|
339
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
339
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/readme-studio.webp" width="240" alt="A factual README with a moving cover, checked at phone and desktop widths in light and dark." /></td>
|
|
340
340
|
<td><code>readme-studio</code><br /><sub><code>$litcodex:readme-studio</code></sub></td>
|
|
341
341
|
<td>A factual README with a moving cover, checked at phone and desktop widths in light and dark.</td>
|
|
342
342
|
</tr>
|
|
343
343
|
<tr>
|
|
344
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
344
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/lit-typographic-motion.webp" width="240" alt="Ask for a video with lit. A treatment comes first, then an authored stage page or the type engine, a sound bed, and look rounds on the rendered stills." /></td>
|
|
345
345
|
<td><code>lit-typographic-motion</code><br /><sub><code>$litcodex:lit-typographic-motion</code></sub></td>
|
|
346
346
|
<td>Ask for a video with <code>lit</code>. A treatment comes first, then an authored stage page or the type engine, a sound bed, and look rounds on the rendered stills.</td>
|
|
347
347
|
</tr>
|
|
348
348
|
<tr>
|
|
349
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
349
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/structural-search.webp" width="240" alt="Finds code by its syntax shape, not its text, and previews rewrites before applying them." /></td>
|
|
350
350
|
<td><code>structural-search</code><br /><sub><code>$litcodex:structural-search</code></sub></td>
|
|
351
351
|
<td>Finds code by its syntax shape, not its text, and previews rewrites before applying them.</td>
|
|
352
352
|
</tr>
|
|
353
353
|
<tr>
|
|
354
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
354
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/visual-qa.webp" width="240" alt="Checks a real screen at each viewport and returns an honest verdict, or names exactly what blocked it." /></td>
|
|
355
355
|
<td><code>visual-qa</code><br /><sub><code>$litcodex:visual-qa</code></sub></td>
|
|
356
356
|
<td>Checks a real screen at each viewport and returns an honest verdict, or names exactly what blocked it.</td>
|
|
357
357
|
</tr>
|
|
358
358
|
<tr>
|
|
359
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
359
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/browser-drive.webp" width="240" alt="Drives a real page after verifying the browser driver. If there is none, it says so." /></td>
|
|
360
360
|
<td><code>browser-drive</code><br /><sub><code>browser-drive</code> · <code>$litcodex:browser-drive</code></sub></td>
|
|
361
361
|
<td>Drives a real page after verifying the browser driver. If there is none, it says so.</td>
|
|
362
362
|
</tr>
|
|
363
363
|
<tr>
|
|
364
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
364
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/frontend-ui-ux.webp" width="240" alt="Builds a working interface, then a measured probe renders it in seven views: four widths, dark, reduced motion and 200% zoom." /></td>
|
|
365
365
|
<td><code>frontend-ui-ux</code><br /><sub><code>$litcodex:frontend-ui-ux</code></sub></td>
|
|
366
366
|
<td>Builds a working interface, then a measured probe renders it in seven views: four widths, dark, reduced motion and 200% zoom.</td>
|
|
367
367
|
</tr>
|
|
368
368
|
<tr>
|
|
369
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
369
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/lit-burnoff.webp" width="240" alt="Cleans AI-written bloat out of a change set after tests lock what it does." /></td>
|
|
370
370
|
<td><code>lit-burnoff</code><br /><sub><code>$litcodex:lit-burnoff</code></sub></td>
|
|
371
371
|
<td>Cleans AI-written bloat out of a change set after tests lock what it does.</td>
|
|
372
372
|
</tr>
|
|
373
373
|
<tr>
|
|
374
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
374
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/lit-burnoff-file.webp" width="240" alt="The same cleanup for one file: fewer narrating comments, less defensive noise, flatter code." /></td>
|
|
375
375
|
<td><code>lit-burnoff-file</code><br /><sub><code>$litcodex:lit-burnoff-file</code></sub></td>
|
|
376
376
|
<td>The same cleanup for one file: fewer narrating comments, less defensive noise, flatter code.</td>
|
|
377
377
|
</tr>
|
|
378
378
|
<tr>
|
|
379
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
379
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/wikify.webp" width="240" alt="Keeps reviewed project knowledge on disk and answers later questions from it, with sources." /></td>
|
|
380
380
|
<td><code>wikify</code><br /><sub><code>$litcodex:wikify</code></sub></td>
|
|
381
381
|
<td>Keeps reviewed project knowledge on disk and answers later questions from it, with sources.</td>
|
|
382
382
|
</tr>
|
|
383
383
|
<tr>
|
|
384
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
384
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/autoresearch.webp" width="240" alt="An approved, budgeted experiment loop. Each round changes one thing and keeps or reverts it." /></td>
|
|
385
385
|
<td><code>autoresearch</code><br /><sub><code>$litcodex:autoresearch</code></sub></td>
|
|
386
386
|
<td>An approved, budgeted experiment loop. Each round changes one thing and keeps or reverts it.</td>
|
|
387
387
|
</tr>
|
|
388
388
|
<tr>
|
|
389
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
389
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/autoconference.webp" width="240" alt="A budgeted research conference: separate researchers, reviewers, and a synthesis that keeps disagreement." /></td>
|
|
390
390
|
<td><code>autoconference</code><br /><sub><code>$litcodex:autoconference</code></sub></td>
|
|
391
391
|
<td>A budgeted research conference: separate researchers, reviewers, and a synthesis that keeps disagreement.</td>
|
|
392
392
|
</tr>
|
|
393
393
|
<tr>
|
|
394
|
-
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
394
|
+
<td><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/skills/automatic-checks.webp" width="240" alt="Runs on its own: project rules on each prompt, LSP and comment checks after edits." /></td>
|
|
395
395
|
<td><code>rules</code> · <code>lsp</code> · <code>comment-checker</code><br /><sub>runs on its own</sub></td>
|
|
396
396
|
<td>Runs on its own: project rules on each prompt, LSP and comment checks after edits.</td>
|
|
397
397
|
</tr>
|
|
@@ -438,49 +438,49 @@ In the interface round the Codex sandbox blocked the browser, so the lit arm's i
|
|
|
438
438
|
|
|
439
439
|
**S3, budget dashboard (baseline left, LitCodex right).**
|
|
440
440
|
|
|
441
|
-
<p><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
441
|
+
<p><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/ab-simple/assets/s3-baseline-desktop.webp" width="49%" alt="Baseline budget dashboard at desktop width" /> <img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/ab-simple/assets/s3-lit-desktop.webp" width="49%" alt="LitCodex budget dashboard at desktop width" /></p>
|
|
442
442
|
|
|
443
443
|
<details><summary>S3 on a phone</summary>
|
|
444
444
|
|
|
445
|
-
<p><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
445
|
+
<p><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/ab-simple/assets/s3-baseline-phone.webp" width="240" alt="Baseline budget dashboard on a phone" /> <img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/ab-simple/assets/s3-lit-phone.webp" width="240" alt="LitCodex budget dashboard on a phone" /></p>
|
|
446
446
|
|
|
447
447
|
</details>
|
|
448
448
|
|
|
449
449
|
**S4, café landing page (baseline left, LitCodex right).**
|
|
450
450
|
|
|
451
|
-
<p><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
451
|
+
<p><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/ab-simple/assets/s4-baseline-desktop.webp" width="49%" alt="Baseline café landing page at desktop width" /> <img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/ab-simple/assets/s4-lit-desktop.webp" width="49%" alt="LitCodex café landing page at desktop width" /></p>
|
|
452
452
|
|
|
453
453
|
<details><summary>S4 on a phone</summary>
|
|
454
454
|
|
|
455
|
-
<p><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
455
|
+
<p><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/ab-simple/assets/s4-baseline-phone.webp" width="240" alt="Baseline café landing page on a phone" /> <img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/ab-simple/assets/s4-lit-phone.webp" width="240" alt="LitCodex café landing page on a phone" /></p>
|
|
456
456
|
|
|
457
457
|
</details>
|
|
458
458
|
|
|
459
459
|
**S5, first five slides (baseline above, LitCodex below).**
|
|
460
460
|
|
|
461
|
-
<p><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
462
|
-
<p><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
461
|
+
<p><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/ab-simple/assets/s5-baseline-slides.webp" width="100%" alt="Baseline slides for the report-and-slides task" /></p>
|
|
462
|
+
<p><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/ab-simple/assets/s5-lit-slides.webp" width="100%" alt="LitCodex slides for the report-and-slides task" /></p>
|
|
463
463
|
|
|
464
464
|
**S7, the LitCodex diagram.** The baseline returned Mermaid code without a rendered file.
|
|
465
465
|
|
|
466
|
-
<p><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
466
|
+
<p><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/ab-simple/assets/s7-lit-diagram.webp" width="720" alt="LitCodex order, payment and shipping service diagram" /></p>
|
|
467
467
|
|
|
468
468
|
**S8, first five slides (baseline above, LitCodex below).**
|
|
469
469
|
|
|
470
|
-
<p><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
471
|
-
<p><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
470
|
+
<p><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/ab-simple/assets/s8-baseline-slides.webp" width="100%" alt="Baseline quarterly results template slides" /></p>
|
|
471
|
+
<p><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/ab-simple/assets/s8-lit-slides.webp" width="100%" alt="LitCodex quarterly results slides with sample figures" /></p>
|
|
472
472
|
|
|
473
473
|
**S9, first three pages of the LitCodex plan.** The baseline answered in chat and made no file.
|
|
474
474
|
|
|
475
|
-
<p><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
475
|
+
<p><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/ab-simple/assets/s9-lit-pages.webp" width="100%" alt="LitCodex new product plan, first three pages" /></p>
|
|
476
476
|
|
|
477
477
|
**S11, meeting-room booking app (baseline left, LitCodex right).**
|
|
478
478
|
|
|
479
|
-
<p><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
479
|
+
<p><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/ab-simple/assets/s11-baseline-desktop.webp" width="49%" alt="Baseline meeting-room booking app at desktop width" /> <img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/ab-simple/assets/s11-lit-desktop.webp" width="49%" alt="LitCodex meeting-room booking app at desktop width" /></p>
|
|
480
480
|
|
|
481
481
|
<details><summary>S11 on a phone</summary>
|
|
482
482
|
|
|
483
|
-
<p><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.
|
|
483
|
+
<p><img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/ab-simple/assets/s11-baseline-phone.webp" width="240" alt="Baseline meeting-room booking app on a phone" /> <img src="https://cdn.jsdelivr.net/npm/@litfamily/litcodex@1.0.8/readme-assets/ab-simple/assets/s11-lit-phone.webp" width="240" alt="LitCodex meeting-room booking app on a phone" /></p>
|
|
484
484
|
|
|
485
485
|
</details>
|
|
486
486
|
|
|
@@ -501,7 +501,7 @@ Append `lit` to a prompt to activate the Codex CLI hook. It routes the request i
|
|
|
501
501
|
|
|
502
502
|
The hook is an entry signal; it does not prove that a model result or visual check completed.
|
|
503
503
|
|
|
504
|
-
<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.
|
|
504
|
+
<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.8/readme-assets/ignition-poster.png" width="720" alt="Ignition motion poster" /></a></p>
|
|
505
505
|
|
|
506
506
|
Select the poster for the optional film; this README keeps motion opt-in.
|
|
507
507
|
|
|
@@ -559,7 +559,7 @@ See [state and recovery](https://github.com/wjgoarxiv/litcodex/blob/main/docs/us
|
|
|
559
559
|
## Verify it worked
|
|
560
560
|
|
|
561
561
|
```sh
|
|
562
|
-
npm exec --yes --package @litfamily/litcodex@1.0.
|
|
562
|
+
npm exec --yes --package @litfamily/litcodex@1.0.8 -- litcodex doctor
|
|
563
563
|
```
|
|
564
564
|
|
|
565
565
|
`litcodex doctor` checks registration, hooks, config, and host capabilities. `litcodex loop doctor` checks
|
|
@@ -577,6 +577,40 @@ project loop state. A successful installation check does not prove authenticated
|
|
|
577
577
|
and opt-out doctor paths stay side-effect-free. See [privacy](https://github.com/wjgoarxiv/litcodex/blob/main/docs/privacy.md).
|
|
578
578
|
- Model routes are configuration choices, not guarantees of access or execution. See [managed model compatibility](https://github.com/wjgoarxiv/litcodex/blob/main/docs/usage.md#safety).
|
|
579
579
|
|
|
580
|
+
## Jev skill hint (optional)
|
|
581
|
+
|
|
582
|
+
LitCodex can ask Jev, a hosted model from TypeSafe (typesafe.ai), which bundled LitCodex skill fits a plain
|
|
583
|
+
prompt. When Jev picks one with enough confidence, the `UserPromptSubmit` hook adds one advisory line naming
|
|
584
|
+
that skill to the turn's context. Codex still decides whether to load it. The hint never grants a permission
|
|
585
|
+
or runs a tool.
|
|
586
|
+
|
|
587
|
+
It is off by default. To turn it on, set both variables in the environment Codex runs in, then restart Codex:
|
|
588
|
+
|
|
589
|
+
```sh
|
|
590
|
+
export LITCODEX_JEV=1
|
|
591
|
+
export TYPESAFE_API_KEY=<your own TypeSafe key>
|
|
592
|
+
```
|
|
593
|
+
|
|
594
|
+
- **Enabling it sends each eligible prompt to TypeSafe (typesafe.ai).** The text is truncated to 2,000
|
|
595
|
+
characters, and home paths, email addresses and token-shaped strings are redacted first. Nothing else from
|
|
596
|
+
the session is sent: no files, tool output or history. Slash commands, `$skill` mentions and prompts that
|
|
597
|
+
already start a lit route are not sent.
|
|
598
|
+
- Anything in the prompt without a token shape is sent as written: hostnames, customer names, or passwords
|
|
599
|
+
that are not written as `password=…`, for example.
|
|
600
|
+
- Because `TYPESAFE_API_KEY` is exported in the shell that starts Codex, Codex's own tools can read it too.
|
|
601
|
+
Use a key dedicated to this feature, with low spend limits.
|
|
602
|
+
- TypeSafe bills your key, at about $0.04 per million input tokens. Each request carries the prompt and the
|
|
603
|
+
skill list. A session makes at most 200 requests (`LITCODEX_JEV_MAX_CALLS`).
|
|
604
|
+
- The hint itself goes only to the model. To see it, also set `LITCODEX_JEV_SHOW=1`: a turn that got a hint
|
|
605
|
+
then shows one line in the Codex transcript, such as `Jev → lit-humanizer (0.37s)`.
|
|
606
|
+
- While it is on, the first prompt of each session that does not start a lit route shows `✦ Jev skill hint ON`
|
|
607
|
+
once, so you can tell it is enabled.
|
|
608
|
+
- Each request waits at most 1.5 seconds. After a timeout or any other failure the turn continues without a
|
|
609
|
+
hint, and one short note appears once per session.
|
|
610
|
+
- `litcodex doctor` shows `Jev skill hint: off`, `on`, or `flag on but TYPESAFE_API_KEY missing`.
|
|
611
|
+
- To turn it off, unset `LITCODEX_JEV` (any value other than `1` also turns it off) and restart Codex.
|
|
612
|
+
See [privacy](https://github.com/wjgoarxiv/litcodex/blob/main/docs/privacy.md#optional-jev-skill-hint).
|
|
613
|
+
|
|
580
614
|
## Troubleshooting
|
|
581
615
|
|
|
582
616
|
- **Pane closes before any output:** the failing stage is unknown. In an already-open terminal, run help,
|
|
@@ -590,7 +624,7 @@ project loop state. A successful installation check does not prove authenticated
|
|
|
590
624
|
## Uninstall
|
|
591
625
|
|
|
592
626
|
```sh
|
|
593
|
-
npm exec --yes --package @litfamily/litcodex@1.0.
|
|
627
|
+
npm exec --yes --package @litfamily/litcodex@1.0.8 -- litcodex uninstall
|
|
594
628
|
```
|
|
595
629
|
|
|
596
630
|
`litcodex uninstall` removes the plugin and LitCodex-managed config while preserving unrelated settings.
|
|
@@ -619,7 +653,7 @@ Tests, fixtures, test helpers, and Vitest configuration remain tracked repositor
|
|
|
619
653
|
|
|
620
654
|
### LITFAMILY
|
|
621
655
|
|
|
622
|
-

|
|
623
657
|
|
|
624
658
|
Five armored machines, one for each product in the LIT family.
|
|
625
659
|
|
|
@@ -627,6 +661,6 @@ Five armored machines, one for each product in the LIT family.
|
|
|
627
661
|
|
|
628
662
|
Select the poster to watch the 10-second film.
|
|
629
663
|
|
|
630
|
-
<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.
|
|
664
|
+
<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.8/readme-assets/ignition-poster.png" width="720" alt="Ignition motion graphic poster" /></a></p>
|
|
631
665
|
|
|
632
666
|
[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)
|
|
@@ -26,6 +26,7 @@ export function renderDoctorText(report) {
|
|
|
26
26
|
: [
|
|
27
27
|
` auto-update: ${report.autoUpdate.enabled ? "enabled" : "disabled"} (${report.autoUpdate.status ?? "no receipt"}; ${report.autoUpdate.detail})`,
|
|
28
28
|
]),
|
|
29
|
+
...(report.jevSkillHint === undefined ? [] : [` Jev skill hint: ${report.jevSkillHint}`]),
|
|
29
30
|
` concurrency: ${capabilityText(report.capabilities.concurrency)}`,
|
|
30
31
|
` probe-only explicit context/auto-compaction override: ${capabilityText(report.capabilities.autoCompaction)}`,
|
|
31
32
|
];
|
package/dist/install/doctor.js
CHANGED
|
@@ -82,6 +82,7 @@ export function runDoctor(deps) {
|
|
|
82
82
|
scientificVisualizationInstalled: false,
|
|
83
83
|
capabilities: unavailableCapabilities,
|
|
84
84
|
autoUpdate: readAutoUpdateReport(deps.env),
|
|
85
|
+
jevSkillHint: jevSkillHintState(deps.env),
|
|
85
86
|
issues,
|
|
86
87
|
warnings,
|
|
87
88
|
};
|
|
@@ -169,10 +170,17 @@ export function runDoctor(deps) {
|
|
|
169
170
|
...bundledSkills,
|
|
170
171
|
capabilities,
|
|
171
172
|
autoUpdate,
|
|
173
|
+
jevSkillHint: jevSkillHintState(deps.env),
|
|
172
174
|
issues,
|
|
173
175
|
warnings,
|
|
174
176
|
};
|
|
175
177
|
}
|
|
178
|
+
/** Mirrors the lit-loop hook switch: `LITCODEX_JEV=1` plus a non-empty `TYPESAFE_API_KEY`. */
|
|
179
|
+
function jevSkillHintState(env) {
|
|
180
|
+
if (env["LITCODEX_JEV"] !== "1")
|
|
181
|
+
return "off";
|
|
182
|
+
return (env["TYPESAFE_API_KEY"]?.trim() ?? "") !== "" ? "on" : "flag on but TYPESAFE_API_KEY missing";
|
|
183
|
+
}
|
|
176
184
|
/** Read the updater receipt without touching the updater lock, journal, or npm. */
|
|
177
185
|
function readAutoUpdateReport(env) {
|
|
178
186
|
const configuredRoot = env["LITCODEX_AUTO_UPDATE_STATE_ROOT"]?.trim();
|
package/dist/install/types.d.ts
CHANGED
|
@@ -89,7 +89,10 @@ export interface DoctorReport {
|
|
|
89
89
|
readonly warnings: readonly string[];
|
|
90
90
|
/** Read-only foreground update barrier state; the updater owns the receipt/journal files. */
|
|
91
91
|
readonly autoUpdate?: AutoUpdateDoctorReport;
|
|
92
|
+
/** Opt-in Jev skill hint switch, read from this process's environment. Never carries the key. */
|
|
93
|
+
readonly jevSkillHint?: JevSkillHintState;
|
|
92
94
|
}
|
|
95
|
+
export type JevSkillHintState = "off" | "on" | "flag on but TYPESAFE_API_KEY missing";
|
|
93
96
|
export interface AutoUpdateDoctorReport {
|
|
94
97
|
readonly enabled: boolean;
|
|
95
98
|
readonly status: string | null;
|