@litfamily/litgrok 1.0.4 → 1.0.6
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/.grok/hooks/lit-status-line.mjs +2 -1
- package/.grok/hooks/record-passive-event.mjs +65 -1
- package/.grok/skills/frontend-ui-ux/SKILL.md +11 -25
- package/.grok/skills/frontend-ui-ux/references/complete-contract.md +21 -27
- package/.grok/skills/frontend-ui-ux/references/production.md +21 -0
- package/.grok/skills/readme-studio/SKILL.md +37 -0
- package/.grok/skills/readme-studio/references/complete-contract.md +26 -0
- package/.grok/skills/readme-studio/references/decoration-patterns.md +29 -0
- package/.grok/skills/readme-studio/references/facts.md +15 -0
- package/.grok/skills/readme-studio/references/motion.md +42 -0
- package/.grok/skills/readme-studio/references/production.md +7 -0
- package/.grok/skills/readme-studio/references/typography.md +16 -0
- package/.grok/skills/readme-studio/scripts/validate-facts.mjs +52 -0
- package/.grok/skills/readme-studio/templates/cover-source.json +27 -0
- package/.grok/skills/readme-studio/templates/facts.json +13 -0
- package/.grok/skills/readme-studio/templates/hyperframes/index.html +41 -0
- package/.grok/skills/readme-studio/templates/hyperframes/index.motion.json +4 -0
- package/.grok/skills/readme-studio/templates/hyperframes/package-lock.json +1845 -0
- package/.grok/skills/readme-studio/templates/hyperframes/package.json +12 -0
- package/.grok/skills/readme-studio/templates/picture.md +61 -0
- package/.grok/skills/readme-studio/templates/remotion/package-lock.json +3785 -0
- package/.grok/skills/readme-studio/templates/remotion/package.json +16 -0
- package/.grok/skills/readme-studio/templates/remotion/src/index.jsx +31 -0
- package/.grok/skills/readme-studio/templates/typography/outline.mjs +62 -0
- package/.grok/skills/readme-studio/templates/typography/package-lock.json +135 -0
- package/.grok/skills/readme-studio/templates/typography/package.json +10 -0
- package/.grok-plugin/plugin.json +2 -1
- package/CHANGELOG.md +9 -0
- package/README.md +136 -134
- package/README_ko-KR.md +136 -134
- package/bin/litgrok.mjs +2 -0
- package/docs/assets/cover-motion-still.webp +0 -0
- package/docs/assets/cover-motion.webp +0 -0
- package/docs/assets/readme/Lucide-LICENSE.txt +43 -0
- package/docs/assets/readme/ascii-readme.svg +5 -0
- package/docs/assets/readme/badge-version.svg +1 -1
- package/docs/assets/readme/lucide-book-open.svg +14 -0
- package/docs/assets/readme/lucide-play.svg +13 -0
- package/docs/assets/readme/lucide-shield-check.svg +14 -0
- package/docs/reference.md +11 -5
- package/docs/reference_ko-KR.md +11 -5
- package/package.json +7 -1
- package/plugin.json +1 -1
package/README.md
CHANGED
|
@@ -1,71 +1,50 @@
|
|
|
1
|
-
<p align="center"><picture><source media="(prefers-reduced-motion: reduce)" srcset="https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.
|
|
2
|
-
<p align="center"><a href="https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.4/docs/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/litgrok@1.0.6/docs/assets/cover-motion-still.webp" /><source media="(prefers-reduced-motion: no-preference)" srcset="https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/docs/assets/cover-motion.webp" /><img src="https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/docs/assets/cover-motion.webp" width="100%" alt="LitGrok motion cover with an orange signal crossing orbital paths above the GROK BUILD wordmark." /></picture></p>
|
|
3
2
|
|
|
4
|
-
<
|
|
5
|
-
<p align="center"><strong>Keep the work lit.</strong></p>
|
|
6
|
-
<p align="center"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.4/docs/assets/litgrok-wordmark.svg" width="480" alt="LITGROK display type" /></p>
|
|
7
|
-
<p align="center"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.4/docs/assets/litgrok-clay-icon.png" width="160" alt="LitGrok clay mark" /></p>
|
|
8
|
-
|
|
9
|
-
Make something useful in Grok Build. Leave the checked result and the next step with your project.
|
|
10
|
-
|
|
11
|
-
[한국어](./README_ko-KR.md) · [Install](#install-in-30-seconds) · [First use](#first-lit-use) · [Reference](./docs/reference.md)
|
|
12
|
-
|
|
13
|
-
<p align="center">
|
|
14
|
-
<a href="#install-in-30-seconds"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.4/docs/assets/readme/badge-version.svg" alt="1.0.4" /></a>
|
|
15
|
-
<a href="./LICENSE"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.4/docs/assets/readme/badge-license.svg" alt="MIT license" /></a>
|
|
16
|
-
</p>
|
|
17
|
-
|
|
18
|
-
<p align="center">
|
|
19
|
-
<a href="./docs/reference.md"><img src="./docs/assets/readme/lucide-book-open.svg" width="16" alt="" /> Docs</a> <a href="#install-in-30-seconds">Install</a> <a href="./docs/assets/readme/ignition-film.mp4"><img src="./docs/assets/readme/lucide-play.svg" width="16" alt="" /> Ignition</a> <a href="./LICENSE"><img src="./docs/assets/readme/lucide-shield-check.svg" width="16" alt="" /> MIT</a>
|
|
20
|
-
</p>
|
|
3
|
+
<p align="center"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/docs/assets/readme/ascii-readme.svg" width="480" alt="LIT ASCII B mark — Grok" /></p>
|
|
21
4
|
|
|
22
|
-
>
|
|
23
|
-
>
|
|
24
|
-
> A bug you want fixed. A screen you want built. A project you want to finish.
|
|
25
|
-
>
|
|
26
|
-
> Starting takes a line. When the session changes, the harder part is finding where you left off. LIT guides you through leaving a goal, a plan, a checked result, and a next step with your project.
|
|
27
|
-
>
|
|
28
|
-
> **Leave something the next session can pick up.**
|
|
29
|
-
|
|
30
|
-
It ships 33 skills, 11 agents, one project rule, and eleven hook registrations. The installer copies the complete payload into your project; Grok Build runs the session and owns model selection.
|
|
31
|
-
|
|
32
|
-
Package: **@litfamily/litgrok** · Version: **1.0.4** · [MIT](./LICENSE)
|
|
33
|
-
|
|
34
|
-
The scientific visualization corpus is packaged at `.grok/vendor/scientific-visualization/`; the numeric `045_scientific-visualization` label remains only in license and provenance filenames.
|
|
35
|
-
|
|
36
|
-
> [!NOTE]
|
|
37
|
-
> Install the scoped package with the registry command below. An absolute local package path is available for an isolated trial. Landing covers and badges ship in the package so they render on npmjs.
|
|
38
|
-
|
|
39
|
-
## Start with one lit task
|
|
40
|
-
|
|
41
|
-
Grok Build uses the explicit `/litwork` route for a bounded task. It owns model execution; LitGrok leaves skills, rules, and checked next steps in the project.
|
|
42
|
-
|
|
43
|
-
| Prompt or route | Effect |
|
|
44
|
-
| --- | --- |
|
|
45
|
-
| `/litwork` | Start the shipped work checklist in Grok Build. |
|
|
46
|
-
| `handoff` or `/lit-handoff` | Carry the checked result and next step into another session. |
|
|
47
|
-
| `/lit-plan` | Write a plan with concrete checks. |
|
|
48
|
-
| `/start-work <approved-plan>` | Execute an approved plan. |
|
|
49
|
-
| `/review-work` | Review a change and its evidence. |
|
|
50
|
-
| `/litresearch` | Run bounded, source-traceable research without overstating evidence. |
|
|
5
|
+
<details>
|
|
6
|
+
<summary>Copy ASCII logo</summary>
|
|
51
7
|
|
|
52
|
-
|
|
8
|
+
```text
|
|
9
|
+
▄▄▄▄
|
|
10
|
+
▗███▌ ▗██████▖
|
|
11
|
+
▗▄▄▄▄▄ ▗▟████▌ ▝██████▘
|
|
12
|
+
▐█████ ▗▟██████▌ ▝▀▜█▀▘
|
|
13
|
+
▐█████ ▗▟███████▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
|
|
14
|
+
▐█████ ▗▟█████████████████████████ ▐█▀
|
|
15
|
+
▐█████ ████████████████████████████▀
|
|
16
|
+
▐█████ ██▛▘ ▄ ▄▄▄▄▖▄▄▄▄▄▄▄▄▄▄▄▄▄▖
|
|
17
|
+
▐█████ ▀ ▄██ ████▌█████████████▌
|
|
18
|
+
▐█████ ▄████ ████▌█████████████▌
|
|
19
|
+
▐█████ ▄█████▛
|
|
20
|
+
▐█████ ▗▟█████▀▘ ▄▄▄▄▄ ▗▖
|
|
21
|
+
▐█████ ▐█████▀ █████ ▐▛▀
|
|
22
|
+
▐█████ ▐███▀ █████
|
|
23
|
+
▐█████ ▐█▀ █████
|
|
24
|
+
▐█████ ▝ █████
|
|
25
|
+
▐█████▄▄▄▄▄▄▄▖ █████
|
|
26
|
+
▐███████████▛ █████
|
|
27
|
+
▐██████████▀ █████
|
|
53
28
|
|
|
54
|
-
In Grok Build, `/litwork` starts the bounded work checklist; `handoff` or `/lit-handoff` carries the checked result and next step; `/lit-plan` records a plan with checks; `/start-work <approved-plan>` executes that plan; `/review-work` inspects the change and its evidence; and `/litresearch` runs bounded, source-traceable research. The expected effect is a resumable, checked project record. The host limit is explicit: Grok Build owns execution and model selection, while LitGrok installs the `.grok` payload; hooks require a trusted Git root and a plain folder may load skills and rules without hooks. These images are static route cues, not proof of live host behavior.
|
|
55
29
|
|
|
56
|
-
|
|
30
|
+
grok
|
|
31
|
+
```
|
|
57
32
|
|
|
58
|
-
|
|
33
|
+
</details>
|
|
59
34
|
|
|
60
|
-
|
|
35
|
+
<h1 align="center">LitGrok</h1>
|
|
36
|
+
<p align="center"><strong>Keep the work lit.</strong></p>
|
|
61
37
|
|
|
62
|
-
|
|
38
|
+
Make something useful in Grok Build. Leave the checked result and the next step with your project.
|
|
63
39
|
|
|
64
|
-
|
|
40
|
+
[한국어](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/README_ko-KR.md) · [Install](#install-in-30-seconds) · [Quick start](#quick-start) · [Reference](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/docs/reference.md)
|
|
65
41
|
|
|
66
|
-
|
|
42
|
+
<p align="center">
|
|
43
|
+
<a href="#install-in-30-seconds"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/docs/assets/readme/badge-version.svg" alt="1.0.6" /></a>
|
|
44
|
+
<a href="https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/LICENSE"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/docs/assets/readme/badge-license.svg" alt="MIT license" /></a>
|
|
45
|
+
</p>
|
|
67
46
|
|
|
68
|
-
|
|
47
|
+
<p align="center"><a href="https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/docs/reference.md"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/docs/assets/readme/lucide-book-open.svg" width="16" alt="" /> Docs</a> <a href="#install-in-30-seconds">Install</a> <a href="https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/docs/assets/cover-motion.webp"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/docs/assets/readme/lucide-play.svg" width="16" alt="" /> Cover motion</a> <a href="https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/LICENSE"><img src="https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/docs/assets/readme/lucide-shield-check.svg" width="16" alt="" /> MIT</a></p>
|
|
69
48
|
|
|
70
49
|
## Install in 30 seconds
|
|
71
50
|
|
|
@@ -82,7 +61,7 @@ LITGROK_PACK='/absolute/path/to/the-provided-package.tgz'
|
|
|
82
61
|
npm exec --yes --package "$LITGROK_PACK" -- litgrok install
|
|
83
62
|
```
|
|
84
63
|
|
|
85
|
-
The default destination is `<project>/.grok/`. Use `--package @litfamily/litgrok@1.0.
|
|
64
|
+
The default destination is `<project>/.grok/`. Use `--package @litfamily/litgrok@1.0.6` for a pinned install, or add `--user` to install under `~/.grok/`. [Install and upgrade details](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/docs/reference.md#install).
|
|
86
65
|
|
|
87
66
|
The persistent Grok status row is optional and user-level only. Opt in with:
|
|
88
67
|
|
|
@@ -90,13 +69,34 @@ The persistent Grok status row is optional and user-level only. Opt in with:
|
|
|
90
69
|
npm exec --yes --package @litfamily/litgrok@latest -- litgrok install --user --status-line
|
|
91
70
|
```
|
|
92
71
|
|
|
93
|
-
This adds `[ui.status_line]` to `~/.grok/config.toml` with a two-second refresh. If a config already exists, LitGrok backs it up before changing it; an existing `ui.status_line` is preserved. `uninstall --user` removes only the unchanged LitGrok-managed value. Grok reads this setting from user or administrator configuration, not from project or plugin configuration ([status-line docs](https://docs.x.ai/build/features/status-line), [settings reference](https://docs.x.ai/build/settings/reference)). Example rows are `🔥 LIT IGNITED · lit-plan 🔥 │ grok-4 │ ctx 42%` and `LIT · grok │ grok-4 │ ctx 42%`. With color enabled, the active `LIT IGNITED · <discipline>` label is bold with a per-character truecolor gradient `#FF6337 → #FF2D95 → #00E5FF`; the flames and model/context segment remain unstyled. `NO_COLOR` (including an empty value) or `LITGROK_HUD_COLOR=0` keeps the row plain. Truecolor, bold and emoji rendering in the status row were confirmed on Grok Build 1.0.13. This adds a status command, not another hook registration; LitGrok still ships eleven hook registrations.
|
|
72
|
+
This adds `[ui.status_line]` to `~/.grok/config.toml` with a two-second refresh. If a config already exists, LitGrok backs it up before changing it; an existing `ui.status_line` is preserved. `uninstall --user` removes only the unchanged LitGrok-managed value. Grok reads this setting from user or administrator configuration, not from project or plugin configuration ([status-line docs](https://docs.x.ai/build/features/status-line), [settings reference](https://docs.x.ai/build/settings/reference)). Example rows are `🔥 LIT IGNITED · lit-plan 🔥 │ grok-4 │ ctx 42%` and `LIT · grok │ grok-4 │ ctx 42%`. The first visible prompt match among `lit-scientific-visualization`, `lit-handoff`, `autoconference`, `autoresearch`, `lit-plan`, and `litwork` sets the discipline; bare `lit` maps to `litwork`, and inline or fenced Markdown code is ignored. With color enabled, the active `LIT IGNITED · <discipline>` label is bold with a per-character truecolor gradient `#FF6337 → #FF2D95 → #00E5FF`; the flames and model/context segment remain unstyled. `NO_COLOR` (including an empty value) or `LITGROK_HUD_COLOR=0` keeps the row plain. Truecolor, bold and emoji rendering in the status row were confirmed on Grok Build 1.0.13. This adds a status command, not another hook registration; LitGrok still ships eleven hook registrations.
|
|
94
73
|
|
|
95
|
-
|
|
74
|
+
### Safety and uninstall
|
|
96
75
|
|
|
97
|
-
|
|
76
|
+
Preview the exact destinations before writing:
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
npm exec --yes --package "$LITGROK_PACK" -- litgrok install --dry-run
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
The installer verifies file ownership before upgrades or removal. Modified, foreign, or unsafe destination files cause the operation to refuse rather than overwrite them. `CI`, `NO_COLOR` (even empty), `--no-color`, and `--dry-run` are no-write previews regardless of `--yes`. Without `--yes`, a non-interactive run is also a no-write preview; with `--yes`, it proceeds without a TTY as long as none of the above apply.
|
|
83
|
+
|
|
84
|
+
For a local-package install, remove it with the same package in the same project. Add `--user` only to remove an installation made with `--user`.
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
npm exec --yes --package "$LITGROK_PACK" -- litgrok uninstall
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Registry uninstall commands:
|
|
98
91
|
|
|
99
|
-
|
|
92
|
+
```bash
|
|
93
|
+
npm exec --yes --package @litfamily/litgrok@latest -- litgrok uninstall
|
|
94
|
+
npm exec --yes --package @litfamily/litgrok@latest -- litgrok uninstall --user
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
User-level uninstall backs up `~/.grok/config.toml` before removing the unchanged LitGrok-managed status-line keys; other settings and a user-edited status line are preserved. Match the scope used for installation. Re-run `install` to update. The installer does not grant hook trust, create a Git root, write login state or API keys, or choose a model. The hedge guard is fail-open on host errors; a passing package test does not prove live Grok behavior. Check `/hooks` and `grok inspect --json` from the repository root in your own session. [Host boundaries and verification](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/docs/reference.md#verify).
|
|
98
|
+
|
|
99
|
+
## Quick start
|
|
100
100
|
|
|
101
101
|
Open or restart Grok Build at the installed project’s Git root. Review and trust its project hooks with `/hooks-trust`, or, on the observed Grok Build 1.0.23 host, use `grok --trust inspect --json`. A plain folder can still load skills and rules while hooks remain unavailable. Check `/skills` for the installed catalog and `/hooks` for hook registrations. LitGrok does not create a Git root or change trust.
|
|
102
102
|
|
|
@@ -120,11 +120,37 @@ For a larger change, start with `/lit-plan`, review the saved plan, then invoke
|
|
|
120
120
|
/lit-handoff Record what we built, what we checked, and what remains. Tell me where you saved the handoff.
|
|
121
121
|
```
|
|
122
122
|
|
|
123
|
-
In the next session, supply that returned path and ask Grok Build to read it and check the current files before continuing. The default is `.handoff/HANDOFF.md` in a new Git project or `HANDOFF.md` in a non-Git workspace. An existing root handoff is reused. [Destination and handoff guidance](
|
|
123
|
+
In the next session, supply that returned path and ask Grok Build to read it and check the current files before continuing. The default is `.handoff/HANDOFF.md` in a new Git project or `HANDOFF.md` in a non-Git workspace. An existing root handoff is reused. [Destination and handoff guidance](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/.grok/skills/lit-handoff/SKILL.md).
|
|
124
124
|
|
|
125
125
|
**Keeping the spark means leaving work another session can pick up.** These are skill-guided steps in your session; LitGrok does not schedule background work or continue after the session ends.
|
|
126
126
|
|
|
127
|
-
##
|
|
127
|
+
## Key features
|
|
128
|
+
|
|
129
|
+
> **A spark has been placed in your hands. Put it to work.**
|
|
130
|
+
>
|
|
131
|
+
> A bug you want fixed. A screen you want built. A project you want to finish.
|
|
132
|
+
>
|
|
133
|
+
> Starting takes a line. When the session changes, the harder part is finding where you left off. LIT guides you through leaving a goal, a plan, a checked result, and a next step with your project.
|
|
134
|
+
>
|
|
135
|
+
> **Leave something the next session can pick up.**
|
|
136
|
+
|
|
137
|
+
It ships 34 skills, 11 agents, one project rule, and eleven hook registrations. The installer copies the complete payload into your project; Grok Build runs the session and owns model selection.
|
|
138
|
+
|
|
139
|
+
Package: **@litfamily/litgrok** · Version: **1.0.6** · [MIT](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/LICENSE)
|
|
140
|
+
|
|
141
|
+
The scientific visualization corpus is packaged at `.grok/vendor/scientific-visualization/`; the numeric `045_scientific-visualization` label remains only in license and provenance filenames.
|
|
142
|
+
|
|
143
|
+
These route examples are static guidance, not proof of live host behavior.
|
|
144
|
+
|
|
145
|
+
The five activation contracts ask the model to start each activated response with exactly one line before other response content. For `/litwork`, the requested line is:
|
|
146
|
+
|
|
147
|
+
🔥 **LIT IGNITED · litwork** 🔥
|
|
148
|
+
|
|
149
|
+
This is advisory prompt guidance; it does not verify native host display.
|
|
150
|
+
|
|
151
|
+
The retained `docs/assets/cover.svg` remains editable vector artwork; the README uses a still frame of the motion cover when reduced motion is preferred.
|
|
152
|
+
|
|
153
|
+
### How it fits inside Grok Build
|
|
128
154
|
|
|
129
155
|
The installer puts files in the project's `.grok/` directory. `/litwork` provides a checklist for the current session; Grok Build owns execution and model selection. These are the main connections.
|
|
130
156
|
|
|
@@ -144,99 +170,75 @@ flowchart TD
|
|
|
144
170
|
|
|
145
171
|
The hooks' `.grok/litgrok/session-ledger/` records event order. Judge success from the artifact and its checks. The user supplies the handoff path in the next session; having a record does not automatically resume work.
|
|
146
172
|
|
|
147
|
-
[Checklist and hook boundaries](
|
|
173
|
+
[Checklist and hook boundaries](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/.grok/skills/litwork/SKILL.md) · [Handoff destinations](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/.grok/skills/lit-handoff/SKILL.md) · [Install details](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/docs/reference.md#install)
|
|
148
174
|
|
|
149
|
-
|
|
175
|
+
### Design and README production
|
|
150
176
|
|
|
151
|
-
|
|
152
|
-
|---|---|
|
|
153
|
-
| Clarify a vague request | [`/deep-interview`](./.grok/skills/deep-interview/SKILL.md) |
|
|
154
|
-
| Write a plan with concrete checks | [`/lit-plan`](./.grok/skills/lit-plan/SKILL.md) |
|
|
155
|
-
| Execute an approved plan | [`/start-work`](./.grok/skills/start-work/SKILL.md) |
|
|
156
|
-
| Keep one task bounded and verifiable | [`/litwork`](./.grok/skills/litwork/SKILL.md) |
|
|
157
|
-
| Review a change and its evidence | [`/review-work`](./.grok/skills/review-work/SKILL.md) |
|
|
158
|
-
| Leave a resumable handoff | [`/lit-handoff`](./.grok/skills/lit-handoff/SKILL.md) |
|
|
177
|
+
Use `/frontend-ui-ux <surface and outcome>` to build and inspect an authorized interface. A clear brief proceeds to working code; material ambiguity prompts a focused question. Review-only and plan-only requests remain read-only.
|
|
159
178
|
|
|
160
|
-
Use `/
|
|
179
|
+
Use `/readme-studio <repository and outcome>` for a source-checked README, outlined Pretendard/Meslo typography, and portable cover/motion recipes. Check `/skills` after installation. Native image generation depends on the tools exposed in your Grok session; `IMAGE_GENERATION_UNAVAILABLE` permits an explicitly supplied background path. Fonts and renderers are task-local prerequisites. Local output is separate from live host and GitHub/npm acceptance. [README Studio](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/.grok/skills/readme-studio/SKILL.md).
|
|
161
180
|
|
|
162
|
-
|
|
181
|
+
The cover is brand motion, not a recording of a Grok task execution.
|
|
163
182
|
|
|
164
|
-
|
|
183
|
+
## Command and hook table
|
|
165
184
|
|
|
166
|
-
|
|
167
|
-
npm exec --yes --package "$LITGROK_PACK" -- litgrok install --dry-run
|
|
168
|
-
```
|
|
185
|
+
### Prompt or route
|
|
169
186
|
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
For a local-package install, remove it with the same package in the same project. Add `--user` only to remove an installation made with `--user`.
|
|
173
|
-
|
|
174
|
-
```bash
|
|
175
|
-
npm exec --yes --package "$LITGROK_PACK" -- litgrok uninstall
|
|
176
|
-
```
|
|
177
|
-
|
|
178
|
-
Registry uninstall commands:
|
|
187
|
+
Grok Build uses the explicit `/litwork` route for a bounded task. It owns model execution; LitGrok leaves skills, rules, and checked next steps in the project.
|
|
179
188
|
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
189
|
+
| Prompt or route | Effect |
|
|
190
|
+
| --- | --- |
|
|
191
|
+
| `/litwork` | Start the shipped work checklist in Grok Build. |
|
|
192
|
+
| `handoff` or `/lit-handoff` | Carry the checked result and next step into another session. |
|
|
193
|
+
| `/lit-plan` | Write a plan with concrete checks. |
|
|
194
|
+
| `/start-work <approved-plan>` | Execute an approved plan. |
|
|
195
|
+
| `/review-work` | Review a change and its evidence. |
|
|
196
|
+
| `/litresearch` | Run bounded, source-traceable research without overstating evidence. |
|
|
184
197
|
|
|
185
|
-
|
|
198
|
+
### Skill catalogue
|
|
186
199
|
|
|
187
|
-
|
|
200
|
+
| Need | Skill |
|
|
201
|
+
|---|---|
|
|
202
|
+
| Clarify a vague request | [`/deep-interview`](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/.grok/skills/deep-interview/SKILL.md) |
|
|
203
|
+
| Write a plan with concrete checks | [`/lit-plan`](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/.grok/skills/lit-plan/SKILL.md) |
|
|
204
|
+
| Execute an approved plan | [`/start-work`](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/.grok/skills/start-work/SKILL.md) |
|
|
205
|
+
| Keep one task bounded and verifiable | [`/litwork`](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/.grok/skills/litwork/SKILL.md) |
|
|
206
|
+
| Review a change and its evidence | [`/review-work`](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/.grok/skills/review-work/SKILL.md) |
|
|
207
|
+
| Leave a resumable handoff | [`/lit-handoff`](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/.grok/skills/lit-handoff/SKILL.md) |
|
|
188
208
|
|
|
189
|
-
|
|
190
|
-
- [Project rule](./.grok/rules/00-litgrok.md) and [skill catalog](./.grok/skills/).
|
|
191
|
-
- [Changelog](./CHANGELOG.md) and [license](./LICENSE).
|
|
209
|
+
Use `/skills` for all 34 skills. [Rename compatibility](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/docs/reference.md#skill-rename-compatibility) covers the one-release aliases; old slash routes are not guaranteed.
|
|
192
210
|
|
|
193
|
-
|
|
194
|
-
- [Privacy and local data](./docs/privacy.md); [migration from the old npm name](./docs/reference.md#npm-package-migration).
|
|
211
|
+
### Project hooks
|
|
195
212
|
|
|
196
|
-
|
|
213
|
+
| Surface | Registration and boundary |
|
|
214
|
+
| --- | --- |
|
|
215
|
+
| Project hooks | Eleven registrations are declared in [`hooks/hooks.json`](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/hooks/hooks.json). They require a trusted Git root and `/hooks-trust`; a plain folder may load skills and rules without hooks. |
|
|
197
216
|
|
|
198
|
-
|
|
217
|
+
## Troubleshooting
|
|
199
218
|
|
|
200
|
-
|
|
219
|
+
### Project hooks
|
|
201
220
|
|
|
202
|
-
|
|
221
|
+
Project hooks need a trusted Git project root in Grok Build. A plain folder can still load the installed skills and rules while hooks remain unavailable. For a new disposable project, run `git init` yourself before trusting it; for an existing repository, open Grok Build from its actual root. The installer never runs `git init` or changes trust. In the observed Grok Build 1.0.23 host, `grok --trust inspect --json` accepted the trust-and-inspect route even though `--trust` was omitted from `grok --help`; this is version-specific behavior.
|
|
203
222
|
|
|
204
|
-
|
|
223
|
+
### Install preview
|
|
205
224
|
|
|
206
|
-
|
|
207
|
-
<summary>Copy ASCII logo</summary>
|
|
225
|
+
If `CI` or `NO_COLOR` is set, even to an empty value, installation is a no-write preview. So is `--no-color`. Without `--yes`, a non-interactive run is also a no-write preview; with `--yes`, installation proceeds without a TTY as long as none of the above apply. Check that the installer reports actual writes before continuing.
|
|
208
226
|
|
|
209
|
-
|
|
210
|
-
▄▄▄▄
|
|
211
|
-
▗███▌ ▗██████▖
|
|
212
|
-
▗▄▄▄▄▄ ▗▟████▌ ▝██████▘
|
|
213
|
-
▐█████ ▗▟██████▌ ▝▀▜█▀▘
|
|
214
|
-
▐█████ ▗▟███████▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
|
|
215
|
-
▐█████ ▗▟█████████████████████████ ▐█▀
|
|
216
|
-
▐█████ ████████████████████████████▀
|
|
217
|
-
▐█████ ██▛▘ ▄ ▄▄▄▄▖▄▄▄▄▄▄▄▄▄▄▄▄▄▖
|
|
218
|
-
▐█████ ▀ ▄██ ████▌█████████████▌
|
|
219
|
-
▐█████ ▄████ ████▌█████████████▌
|
|
220
|
-
▐█████ ▄█████▛
|
|
221
|
-
▐█████ ▗▟█████▀▘ ▄▄▄▄▄ ▗▖
|
|
222
|
-
▐█████ ▐█████▀ █████ ▐▛▀
|
|
223
|
-
▐█████ ▐███▀ █████
|
|
224
|
-
▐█████ ▐█▀ █████
|
|
225
|
-
▐█████ ▝ █████
|
|
226
|
-
▐█████▄▄▄▄▄▄▄▖ █████
|
|
227
|
-
▐███████████▛ █████
|
|
228
|
-
▐██████████▀ █████
|
|
227
|
+
**Status row missing:** the persistent row is optional and uses user or administrator configuration; project and plugin configuration are not read for this setting. See the [status-line reference](https://docs.x.ai/build/features/status-line).
|
|
229
228
|
|
|
229
|
+
For host limits and current verification steps, see the [operational reference](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/docs/reference.md#verify).
|
|
230
230
|
|
|
231
|
-
|
|
232
|
-
```
|
|
231
|
+
## Links
|
|
233
232
|
|
|
234
|
-
|
|
233
|
+
- [Operational reference](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/docs/reference.md): installation, hooks, terminal output, payload checks, and source provenance.
|
|
234
|
+
- [Project rule](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/.grok/rules/00-litgrok.md) and [skill catalog](https://github.com/wjgoarxiv/litgrok/tree/main/.grok/skills).
|
|
235
|
+
- [Changelog](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/CHANGELOG.md) and [license](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/LICENSE).
|
|
235
236
|
|
|
236
|
-
|
|
237
|
+
- [Contributing](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/CONTRIBUTING.md), [security](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/SECURITY.md), [conduct](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/CODE_OF_CONDUCT.md), and [support](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/SUPPORT.md).
|
|
238
|
+
- [Privacy and local data](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/docs/privacy.md); [migration from the old npm name](https://cdn.jsdelivr.net/npm/@litfamily/litgrok@1.0.6/docs/reference.md#npm-package-migration).
|
|
237
239
|
|
|
238
|
-
|
|
240
|
+
### LITFAMILY
|
|
239
241
|
|
|
240
|
-
|
|
242
|
+

|
|
241
243
|
|
|
242
|
-
|
|
244
|
+
The static cover shows five armored machines representing the products. Each works independently in its own host; they do not need to be installed together or connected to one another.
|