Redredchen01/grok-build-hud
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clarify third-party status: not an xAI official plugin

Browse Source 
Remove “official plugin format” wording; state community ownership
and local plugin install only in README, package, skill, and install copy.
This commit is contained in:
red chen
2026-07-17 16:48:16 +08:00
parent 0433fef40e
commit 9225922a10
10 changed files with 34 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.grok-plugin/marketplace.json
+1 -1
View File
@@ -6,7 +6,7 @@
{
"name": "grok-build-hud",
"source": { "type": "local", "path": ".." },
"description": "Grok Build live multi-line status strip (context, quota, tokens, tools) — same-window tmux HUD",
"description": "Third-party Grok Build status strip (not xAI official) — context, quota, tokens, tools; same-window tmux HUD",
"category": "monitoring"
}
]
CHANGELOG.md
+3 -1
View File
@@ -2,10 +2,12 @@
## 0.3.12
### Repo
### Repo / docs
- **Gitea rename**: `Redredchen01/grok-hud` → `Redredchen01/grok-build-hud`
(same host). Clone URL, remotes, package/plugin homepage, and all docs updated.
- CLI short aliases (`grok-hud`, `grok-hud-run`) unchanged.
- **Disclaimer**: docs clarify this is a **third-party / community** project,
not an xAI official plugin; “official plugin format” wording removed.
## 0.3.11
CONTRIBUTING.md
+1 -1
View File
@@ -4,7 +4,7 @@
## 定位
本仓库以 **Grok 插件** 形式交付（`plugin.json` + `commands/` + `skills/` + `hooks/`），运行时依赖 Node CLI + 同窗口 tmux 状态条。改文档时保持「插件优先」表述。
本仓库是**我们自研的第三方工具**（非 xAI 官方），以 Grok **插件机制**交付（`plugin.json` + `commands/` + `skills/` + `hooks/`），运行时依赖 Node CLI + 同窗口 tmux 状态条。文档中勿写成「官方插件」。
## 环境
README.en.md
+11 -6
View File
@@ -1,6 +1,6 @@
# grok-build-hud
**Live multi-line status strip for [Grok Build](https://x.ai/cli) — shipped as a Grok plugin**
**Third-party live status strip for [Grok Build](https://x.ai/cli)** — community-built, **not** an xAI official plugin
> Primary docs (Chinese): [README.md](./README.md)
@@ -25,17 +25,20 @@ ctx ██████░░░░ 50% (252k/500k) · i … o … c 99% · use 2
Repo: http://172.238.15.154:3000/Redredchen01/grok-build-hud
Plugin id: `grok-build-hud` · version in [`plugin.json`](./plugin.json)
> **Disclaimer:** Built and maintained by us (community / third-party). **Not** affiliated with, endorsed by, or part of xAI / official Grok Build. We only use Grok’s local plugin packaging (`plugin.json`, etc.) so you can `grok plugin install` from this repo.
---
## What it is
| Layer | Role |
|-------|------|
| **Delivery** | **Grok plugin** (`plugin.json` + `commands/` + `skills/` + `hooks/`) |
| **Identity** | **Third-party / community** tool — not xAI official |
| **Delivery** | Packaged for Grok’s **plugin mechanism** (`plugin.json` + `commands/` + `skills/` + `hooks/`) |
| **Runtime** | Node CLI + **same-window tmux status strip** |
| **Skill** | Bundled agent skill for in-session discovery |
One line: a bottom status bar for Grok Build — context, quota, tokens, tools, todos.
One line: our own bottom status bar for Grok Build — context, quota, tokens, tools, todos — installable as a local Grok plugin.
---
@@ -49,7 +52,7 @@ One line: a bottom status bar for Grok Build — context, quota, tokens, tools,
## Install (recommended)
One script: **build CLI → install tmux HUD → register as Grok plugin**.
One script: **build CLI → install tmux HUD → register as a local (third-party) Grok plugin**.
```bash
git clone http://172.238.15.154:3000/Redredchen01/grok-build-hud.git
@@ -84,7 +87,9 @@ npm install && npm run build && npm link
npm run install-local
```
### Register as Grok plugin (slash commands + skill + hooks)
### Register as a local Grok plugin (slash commands + skill + hooks)
Installs **this repo** into your machine’s Grok plugin directory — not an xAI official marketplace package.
Build first (`dist/` is required by hooks):
@@ -184,4 +189,4 @@ Primary documentation is **Chinese** ([README.md](./README.md)). Commit messages
## License
MIT. Unofficial third-party tool; not affiliated with xAI.
MIT. **Third-party / community-built** — not affiliated with, endorsed by, or part of xAI. Quota APIs follow xAI and may change.
README.md
+12 -7
View File
@@ -1,6 +1,6 @@
# grok-build-hud
**Grok Build 官方插件格式的实时状态条**
**面向 Grok Build 的第三方实时状态条**（社区自研，非 xAI 官方）
> English: [README.en.md](./README.en.md)
@@ -25,17 +25,20 @@ Grok 4.5 · AI FILM SPACE/0717 · ●
仓库：http://172.238.15.154:3000/Redredchen01/grok-build-hud
插件名：`grok-build-hud` · 版本见 [`plugin.json`](./plugin.json)
> **说明：** 本项目由我们自行开发与维护，**不是** xAI / Grok Build 官方插件或官方功能。仅兼容 Grok 的插件安装机制（`plugin.json` 等），便于本地 `grok plugin install`。
---
## 这是什么
| 层级 | 说明 |
|------|------|
| **交付形态** | **Grok 插件**（`plugin.json` + `commands/` + `skills/` + `hooks/`） |
| **身份** | **第三方 / 社区自研**工具，与 xAI 无官方从属 |
| **交付形态** | 按 Grok **插件机制**打包（`plugin.json` + `commands/` + `skills/` + `hooks/`） |
| **运行时** | Node CLI（`grok-hud` / `grok-build-hud`）+ **同窗口 tmux 状态条** |
| **Skill** | 插件内附带，方便会话里被 agent 识别与调用 |
**一句话：** 给 Grok Build 用的底部状态栏——上下文、配额、token、工具与待办，一眼看到。
**一句话：** 给我们自己用的 Grok Build 底部状态栏——上下文、配额、token、工具与待办，一眼看到；顺带可装成 Grok 插件。
---
@@ -72,7 +75,7 @@ Grok 4.5 · AI FILM SPACE/0717 · ●
## 安装（推荐一键）
从 Gitea 克隆后执行安装脚本：**编译 CLI → 装 tmux 状态条 → 注册为 Grok 插件**。
从 Gitea 克隆后执行安装脚本：**编译 CLI → 装 tmux 状态条 → 注册为本地 Grok 插件（第三方）**。
```bash
git clone http://172.238.15.154:3000/Redredchen01/grok-build-hud.git
@@ -123,7 +126,9 @@ npm run install-local
# 等价于：--install-dashboard + --theme auto + --preset full
```
### 2）注册为 Grok 插件（斜杠命令 + skill + session hooks）
### 2）注册为本地 Grok 插件（斜杠命令 + skill + session hooks）
> 这是把**本仓库**装进本机 Grok 的插件目录，不是从 xAI 官方 marketplace 安装。
须先完成编译（插件 hooks 依赖 `dist/`）：
@@ -282,7 +287,7 @@ grok-build-hud --theme auto
## 插件结构
本仓库按 Grok 插件清单组织，可直接 `grok plugin install .`：
本仓库按 Grok 的**插件清单约定**组织（便于本地安装），可直接 `grok plugin install .`：
```text
grok-build-hud/ # Gitea 仓库目录名
@@ -374,4 +379,4 @@ npm run plugin:validate # 需本机有 grok CLI
## License
MIT。第三方工具，与 xAI 无官方从属关系；配额接口以 xAI 实际 API 为准，可能变更。
MIT。**第三方 / 社区自研**，与 xAI 无官方从属、无官方背书；不代表 xAI 观点或产品。配额等接口以 xAI 实际 API 为准，可能变更。
commands/setup.md
+1 -1
View File
@@ -4,7 +4,7 @@ description: Install grok-build-hud dashboard + same-window multi-line status
# grok-build-hud setup
本仓库是 **Grok 插件**（`plugin.json`）。完整体验 = 插件 + 同窗口 tmux 状态条。
本仓库是**第三方** Grok 插件（`plugin.json`，非 xAI 官方）。完整体验 = 本地插件 + 同窗口 tmux 状态条。
## 推荐：一键安装
package.json
+1 -1
View File
@@ -1,7 +1,7 @@
{
"name": "grok-build-hud",
"version": "0.3.12",
"description": "Grok Build 插件：同窗口实时状态条（上下文、配额、token、工具与待办）；plugin + CLI + tmux HUD",
"description": "第三方 Grok Build 状态条（非 xAI 官方）：同窗口上下文/配额/token/工具；plugin + CLI + tmux HUD",
"type": "module",
"main": "dist/src/index.js",
"bin": {
plugin.json
+1 -1
View File
@@ -1,7 +1,7 @@
{
"name": "grok-build-hud",
"version": "0.3.12",
"description": "Grok Build 插件：同窗口实时状态条（上下文、配额、入出缓存 token、工具与待办）；tmux 多行 HUD + 会话斜杠命令",
"description": "第三方 Grok Build 状态条（非官方）：同窗口上下文/配额/token/工具/待办；tmux HUD + 会话斜杠命令",
"author": {
"name": "Redredchen01"
},
scripts/install.sh
+2 -2
View File
@@ -43,7 +43,7 @@ node bin/grok-build-hud.js --install-dashboard
node bin/grok-build-hud.js --theme auto
node bin/grok-build-hud.js --preset full
echo "==> [5/5] 注册为 Grok 插件 (commands / skills / hooks)"
echo "==> [5/5] 注册为本地 Grok 插件（第三方 / 非官方 marketplace）"
if command -v grok >/dev/null 2>&1; then
# Prefer enable after install; re-run is ok for updates
# Use absolute path (no trailing /.) so installed-plugins id stays stable
@@ -67,7 +67,7 @@ fi
echo ""
VER="$(node -e "import('node:fs').then(fs=>console.log(JSON.parse(fs.readFileSync('package.json','utf8')).version))" 2>/dev/null || echo "?")"
echo "完成。grok-build-hud v${VER}（Grok 插件 + 同窗口 HUD）"
echo "完成。grok-build-hud v${VER}（第三方插件 + 同窗口 HUD，非 xAI 官方）"
echo ""
echo " 启动 Grok + 底部 HUD： grok"
echo " 看当前状态一次： grok-hud status"
skills/grok-build-hud/SKILL.md
+1 -1
View File
@@ -5,7 +5,7 @@ description: Grok Build 实时状态条（同窗口多行：上下文、配额
# grok-build-hud
**Grok Build 插件**：同窗口实时状态条（tmux）——上下文、配额、入/出/缓存 token、工具与待办。读本机会话文件与已有登录查配额，不另开窗口。
**第三方 Grok Build 状态条（非 xAI 官方）**：同窗口实时状态条（tmux）——上下文、配额、入/出/缓存 token、工具与待办。读本机会话文件与已有登录查配额，不另开窗口。按 Grok 插件机制打包，便于本地安装。
## What it shows