Files

T

ZacharyZhang-NY d6c20fc13f M0: compilable skeleton — Kigi 0.1.0 fork surgery

Hard fork of xai-org/grok-build (Apache-2.0) re-targeted as Kigi, an
unofficial Kimi Code CLI community build.

Rename & identity
- 72 xai-*/xai-grok-* crates -> kigi-* (explicit: xai-grok-pager-bin ->
  kigi-bin [binary `kigi`], xai-grok-pager -> kigi-tui; rest mechanical);
  ptyctl, ptyctl-cli, third_party/ unchanged; proto package
  xai.grok.tools.v1 -> kigi.tools.v1
- Config home ~/.kigi (KIGI_SHARE_DIR override), env prefix GROK_* ->
  KIGI_*, `kigi --version` carries the unofficial-community-build notice
- clap identity, help text, startup banner, prompt templates rebranded
  (templates re-encrypted)

Deletions (PRD removal list #5/#6/#7/#9/#10)
- voice input (xai-grok-voice) and all TUI wiring
- telemetry: Mixpanel client, external OTel stream, Sentry, OTLP layers,
  trace/GCS/S3 upload queues (kigi-file-utils halved), workspace upload
  module & dc_log, heap-profile uploader, auth-diagnostics uploader,
  session-analytics halves of feedback; local zero-egress observability
  preserved in new kigi-log crate (unified log, --debug firehose,
  subsystem file logs, opt-in instrumentation)
- announcements (crate, remote-settings fields, TUI surfaces)
- plugin marketplace (crate, sources/browse/CTA/extensions-modal tab);
  direct plugin install/uninstall/update via kigi-agent git_install kept
- relay/gateway/assets endpoints and features (agent relay, headless
  relay transport, gateway bridge, LeaderEnvUrls); leader IPC socket now
  ~/.kigi/leader.sock + KIGI_LEADER_SOCKET, no ws-url derivation
- functional types rehomed instead of deleted: PermissionMode ->
  kigi-config-types, McpInitStrategy -> kigi-mcp, PrCreationSource ->
  session signals, TerminalDiagnostics -> kigi-pager-render, agent_id ->
  shell util

Endpoints
- kigi-env rewritten: single production KigiEndpoints {coding_api_base_url
  https://api.kimi.com/coding/v1 (KIGI_CODE_BASE_URL), oauth_host
  https://auth.kimi.com (KIGI_OAUTH_HOST), update_base_url (GitHub
  Releases API), upgrade_page_url}; GrokBuildEnvironment enum deleted

Toolchain & workspace hygiene
- Rust 1.97.0 pinned; edition 2024; full cargo update; git2 hoisted to
  workspace at 0.21 (Option->Result API migration), quick-xml 0.41
- Root Cargo.toml hand-maintained (PRD §8.1): version 0.1.0 inherited by
  all members, members sorted, unused deps pruned
- cargo-deny advisories gate (deny.toml with documented transitive
  exceptions); CI workflow (check/clippy/fmt/deny/test, macOS+Linux)
- cross-crate test seams re-gated behind `test-support` cargo feature;
  insta snapshot baselines renamed to the kigi_tui prefix
- clippy --workspace --all-targets: zero warnings; fmt clean

Fixes surfaced by the port
- updater probe/installer divergence (bin/kigi vs bin/grok symlink set)
- idle model-metadata refresh dead under KIGI_CODE_BASE_URL override
  (new is_effective_coding_endpoint_url, loopback+override aware)
- macOS symlinked-TMPDIR fixture canonicalization (foreign_sessions,
  fast-worktree); RSS measurement tests serialized via serial_test

Docs & legal (Apache §4)
- NOTICE added (upstream attribution + change statement); THIRD-PARTY
  notices sustained; kigi-tools ported-code notices extended; README,
  CONTRIBUTING, SECURITY, AGENTS.md rewritten

Out of scope for M0 (tracked): Kimi auth/inference (M1), search/fetch,
command parity, config import (M2), Computer Hub excision & final
brand-token sweep (M2), distribution & self-update rewrite (M3).

2026-07-17 05:31:01 -04:00

3.4 KiB

Raw Blame History

Hooks & Plugins Guide

Grok Build supports hooks (event-driven shell commands) and plugins (bundles of skills, agents, hooks, and MCP servers). Both are managed through a unified modal interface.

Method	Opens on tab
`Ctrl+L`	Plugins (any pane; non–VS Code family — on VS Code / Cursor / Windsurf / Zed use `/plugins`)
`/plugins`	Plugins (any terminal)
`/hooks`	Hooks

Tabs

The modal has four tabs: Hooks, Plugins, Skills, and MCP Servers. Switch between them with Tab / → (forward) or Shift+Tab / ← (backward).

Hooks Tab

Hooks are shell commands (or HTTP calls) that run automatically on events like session_start, post_tool_use, notification, etc. See Creating Custom Hooks for how to write your own.

Hooks are grouped by source:

Global hooks — from ~/.kigi/hooks/
Project hooks — from .kigi/hooks/ in your repo
Plugin hooks — bundled with installed plugins
Custom hooks — added manually via a path

Each hook shows:

Event it triggers on (e.g., session_start, post_tool_use)
Command or URL that runs
Timeout duration
Status — enabled or [disabled]

Shortcuts (Hooks tab)

Key	Action
`l`	Reload all hooks
`a`	Add hook from path
`r`	Remove selected hook
`e`	Enable / disable selected hook
`Space`	Expand / collapse group

Plugins Tab

Plugins are directories containing any combination of skills, agents, hooks, and MCP server configs.

Each plugin shows (when expanded):

Name and version
Scope — user, project, or cli
Skills — names or count
Agents — names or count
Hooks — count
MCP servers — count (or "blocked" if not trusted)
Description
Conflicts — ⚠ warning if any

Plugin hooks automatically receive KIGI_PLUGIN_ROOT and KIGI_PLUGIN_DATA environment variables (see the Plugins guide).

Shortcuts (Plugins tab)

Key	Action
`r`	Reload all plugins
`i`	Install plugin from path
`e`	Enable / disable selected plugin
`Space`	Expand / collapse plugin details
`/`	Search plugins by name

General Keyboard Shortcuts

These work across all tabs:

Key	Action
`Tab` / `→`	Next tab
`Shift+Tab` / `←`	Previous tab
`j` / `↓`	Move selection down
`k` / `↑`	Move selection up
`Space`	Toggle expand / collapse
`/`	Start search (Plugins)
`Backspace`	Delete search char, or re-enter search
`Esc`	Clear search, or close modal
`q`	Close modal

Confirmation & Errors

Some actions (like uninstalling a plugin) may ask for confirmation:

Press y to confirm
Press Esc or any other key to cancel

Errors are shown as a message overlay — press any key to dismiss.

While an action is in progress, the modal shows "Processing..." and blocks input until the operation completes.

3.4 KiB Raw Blame History Unescape Escape