Files
grok-build-hud/commands/setup.md
T
Redredchen01 9225922a10 Clarify third-party status: not an xAI official plugin
Remove “official plugin format” wording; state community ownership
and local plugin install only in README, package, skill, and install copy.
2026-07-17 16:48:16 +08:00

56 lines
1.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
description: Install grok-build-hud dashboard + same-window multi-line status
---
# grok-build-hud setup
本仓库是**第三方** Grok 插件(`plugin.json`,非 xAI 官方)。完整体验 = 本地插件 + 同窗口 tmux 状态条。
## 推荐:一键安装
在插件 / 仓库根目录:
```bash
bash scripts/install.sh
```
会:编译 → `npm link``--install-dashboard``grok plugin install . --trust`
## 分步
```bash
npm install && npm run build
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
```
或:`npm run install-local`(仅 CLI + dashboard,不含插件注册)。
## Start Grok with HUD (same Terminal tab)
```bash
grok
# 兼容:grok-hud-run
```
You should see **23 rows** at the bottom (context + usage bars), not a second window.
## Hooks only (scrollback annotations)
```bash
node bin/grok-build-hud.js --install-hooks
```
Reload in Grok: `/hooks` then press `r`.
## Verify
```bash
grok-hud status
grok plugin details grok-build-hud
```