Release v0.3.11: position repo as Grok plugin with clearer install

Document plugin-first packaging (manifest, commands, skills, hooks) and
have install.sh build the CLI, install the tmux dashboard, and register
the plugin so clone-and-setup matches how the project is shipped.
This commit is contained in:
2026-07-17 16:45:10 +08:00
parent e32e0df209
commit 5b35551434
11 changed files with 344 additions and 113 deletions
+20 -10
View File
@@ -4,22 +4,37 @@ description: Install grok-build-hud dashboard + same-window multi-line status
# grok-build-hud setup
One-time setup (from the plugin / repo root):
本仓库是 **Grok 插件**`plugin.json`)。完整体验 = 插件 + 同窗口 tmux 状态条。
## 推荐:一键安装
在插件 / 仓库根目录:
```bash
bash scripts/install.sh
```
会:编译 → `npm link``--install-dashboard``grok plugin install . --trust`
## 分步
```bash
npm install && npm run build
# Preferred: full same-window HUD (tmux multi-line strip)
npm link
node bin/grok-build-hud.js --install-dashboard
node bin/grok-build-hud.js --theme auto
node bin/grok-build-hud.js --preset full
grok plugin install . --trust
grok plugin enable grok-build-hud
```
Or: `bash scripts/install.sh` / `npm run install-local`.
或:`npm run install-local`(仅 CLI + dashboard,不含插件注册)。
## Start Grok with HUD (same Terminal tab)
```bash
grok-hud-run
grok
# 兼容:grok-hud-run
```
You should see **23 rows** at the bottom (context + usage bars), not a second window.
@@ -32,14 +47,9 @@ node bin/grok-build-hud.js --install-hooks
Reload in Grok: `/hooks` then press `r`.
Example annotation:
```text
[hud] ctx 30% 154k/500k │ turns 3 │ tools 78 │ live │ project
```
## Verify
```bash
grok-hud status
grok plugin details grok-build-hud
```