Files
Kigi-CLI/crates/codegen/kigi-hooks/examples/README.md
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.5 KiB

Hook Examples

Sample hooks for Grok. Copy to ~/.kigi/hooks/ to enable globally, or to <project>/.kigi/hooks/ for project-scoped hooks (requires /hooks-trust).

Available Examples

1. Safe Shell Guard (safe-shell.json)

Type: blocking (PreToolUse)

Denies obviously destructive shell commands before they execute:

  • rm -rf /, sudo rm -rf, mkfs, dd to devices, fork bombs

Install:

mkdir -p ~/.kigi/hooks/bin
cp examples/hooks/safe-shell.json ~/.kigi/hooks/
cp examples/hooks/bin/safe-shell-guard.sh ~/.kigi/hooks/bin/
chmod +x ~/.kigi/hooks/bin/safe-shell-guard.sh

2. No Recursive Grep (no-recursive-grep.json)

Type: blocking (PreToolUse)

Denies recursive grep invocations in the shell before they execute:

  • grep -r, grep -R, grep --recursive, grep --dereference-recursive, grep -d recurse, clustered flags (grep -rn, grep -nri), and rgrep

Recursive grep walks an entire directory tree into memory and can OOM-kill the agent process on large repos. The system prompt already steers the model away from this, but a prompt is advisory — this hook makes it a hard, deterministic block. Point the model at the dedicated search tool (ripgrep-backed) instead.

It is careful to avoid false positives: ls -R | grep foo (the -R belongs to ls), grep -e -r file (-r is the pattern), and grep -- -r file are all allowed.

Install:

mkdir -p ~/.kigi/hooks/bin
cp examples/hooks/no-recursive-grep.json ~/.kigi/hooks/
cp examples/hooks/bin/no-recursive-grep-guard.py ~/.kigi/hooks/bin/
chmod +x ~/.kigi/hooks/bin/no-recursive-grep-guard.py

(Requires python3 on PATH.)

3. Session Audit Log (session-log.json)

Type: passive (SessionStart + SessionEnd)

Appends session metadata to ~/.kigi/session-audit.log — event, session ID, cwd, timestamp.

Install:

mkdir -p ~/.kigi/hooks/bin
cp examples/hooks/session-log.json ~/.kigi/hooks/
cp examples/hooks/bin/session-log.sh ~/.kigi/hooks/bin/
chmod +x ~/.kigi/hooks/bin/session-log.sh

4. Tool Activity Logger (tool-logger.json)

Type: passive (PreToolUse + PostToolUse)

Logs all tool calls to ~/.kigi/tool-activity.log — tool name, event type, effective tool name, backgrounded status.

Install:

mkdir -p ~/.kigi/hooks/bin
cp examples/hooks/tool-logger.json ~/.kigi/hooks/
cp examples/hooks/bin/tool-logger.sh ~/.kigi/hooks/bin/
chmod +x ~/.kigi/hooks/bin/tool-logger.sh

Format

Hook files use the Claude-compatible JSON format:

{
  "hooks": {
    "PreToolUse": [
      {
        "matcher": "Bash",
        "hooks": [
          { "type": "command", "command": "bin/check.sh", "timeout": 5 }
        ]
      }
    ]
  }
}
  • Event names: SessionStart, PreToolUse, PostToolUse, SessionEnd
  • Matcher: regex on tool name. Claude names like Bash, Read, Edit are auto-expanded to also match Grok names (run_terminal_cmd, read_file, search_replace)
  • Timeout: in seconds (default: 5)
  • Command: path to script (relative to hook file directory) or inline shell command

Script Contract

Scripts receive the hook event envelope as JSON on stdin and should write a response to stdout:

For blocking hooks (PreToolUse):

{"decision":"allow"}

or

{"decision":"deny","reason":"Explanation for the user"}

Exit codes: 0 = allow, 2 = deny, other = fail-open.

For passive hooks: stdout is informational only. Exit 0 for success.

Uninstall

Remove the JSON file from ~/.kigi/hooks/. The hook stops running on the next session.