Files

T

Redredchen01 18c04f5874 Remove third-party identity from package metadata; point docs to Gitea

Drop former GitHub org/user references and personal email from plugin
metadata. Clone URLs and repository fields now point at the Gitea host.

2026-07-17 16:30:16 +08:00

Contributing

Setup

git clone http://172.238.15.154:3000/Redredchen01/grok-hud.git
cd grok-hud
npm install
npm test

Path	Role
`src/`	TypeScript sources (session, billing, status, tmux, theme, CLI)
`bin/`	CLI entrypoints (`grok-build-hud`, `grok-hud`, `grok-hud-run`, hook)
`tests/`	Node built-in test runner (`node --test`)
`fixtures/`	Session + billing samples for tests
`commands/` / `skills/`	Grok plugin surface
`scripts/install.sh`	One-shot local install

Prefer reading local ~/.grok/sessions/** over inventing APIs.
Billing must degrade gracefully when offline / unauthenticated (never throw in render path).
Keep the HUD same-window (tmux status). Do not require a second Terminal window by default.
Add or update a test when changing parse/normalize/render behaviour.
Commit messages in English; user-facing docs may be EN + ZH.

npm test

All 40 tests should pass.