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).
99 lines
4.3 KiB
Rust
99 lines
4.3 KiB
Rust
//! Filesystem path tables for sandbox profiles.
|
|
//!
|
|
//! Collects device files, temp directories, sensitive deny-paths, and
|
|
//! ecosystem (package-manager / toolchain) writable paths into helpers
|
|
//! consumed by [`super::profiles`].
|
|
|
|
#[cfg(all(feature = "enforce", unix))]
|
|
use std::path::Path;
|
|
use std::path::PathBuf;
|
|
|
|
// ── Grok state directory ────────────────────────────────────────────────────
|
|
|
|
/// Grok state directory — always writable (`$KIGI_SHARE_DIR` or `~/.kigi`).
|
|
pub(crate) fn kigi_home() -> PathBuf {
|
|
kigi_config::kigi_home()
|
|
}
|
|
|
|
// ── Device files & directories ──────────────────────────────────────────────
|
|
|
|
/// Device files that need write access for normal tool operation.
|
|
///
|
|
/// Without write access to these, common programs (git, curl, ssh, compilers)
|
|
/// break because they can't open `/dev/null` as an output sink, allocate PTYs,
|
|
/// or seed RNGs.
|
|
///
|
|
/// These are individual files (use `allow_file`, not `allow_path`).
|
|
/// `/dev/pts` is a directory (PTY slaves on Linux) so it uses `allow_path`.
|
|
#[cfg(all(feature = "enforce", unix))]
|
|
pub(crate) const DEVICE_FILES: &[&str] = &[
|
|
"/dev/null", // output sink — used by virtually every CLI tool
|
|
"/dev/zero", // zero source — used by memory allocators
|
|
"/dev/random", // entropy — used by crypto/TLS
|
|
"/dev/urandom", // entropy — used by crypto/TLS
|
|
"/dev/tty", // controlling terminal — used by git, ssh, gpg
|
|
"/dev/ptmx", // PTY allocation — used by terminal spawning
|
|
"/dev/fd", // file descriptor access (symlink to /proc/self/fd on Linux)
|
|
];
|
|
|
|
/// Device directories that need write access.
|
|
#[cfg(all(feature = "enforce", unix))]
|
|
pub(crate) const DEVICE_DIRS: &[&str] = &[
|
|
"/dev/pts", // PTY slaves (Linux)
|
|
];
|
|
|
|
// ── Temporary directories ───────────────────────────────────────────────────
|
|
|
|
/// Temporary directories that need write access.
|
|
///
|
|
/// On Linux, `/tmp` is the standard temp directory.
|
|
/// On macOS, programs use both `/tmp` (symlink to `/private/tmp`) and
|
|
/// `/private/var/folders/` (the real `TMPDIR` / `NSTemporaryDirectory()`).
|
|
/// git, compilers, and other tools write temp files to `$TMPDIR` which
|
|
/// resolves to `/private/var/folders/xx/.../T/` on macOS.
|
|
#[cfg(all(feature = "enforce", unix))]
|
|
pub(crate) fn temp_writable_paths() -> Vec<PathBuf> {
|
|
let mut paths = vec![PathBuf::from("/tmp"), PathBuf::from("/var/tmp")];
|
|
|
|
// macOS: /tmp → /private/tmp, but the real TMPDIR is under /private/var/folders.
|
|
// Also include /private/tmp since Seatbelt may resolve the symlink.
|
|
if cfg!(target_os = "macos") {
|
|
for p in ["/private/tmp", "/private/var/tmp", "/private/var/folders"] {
|
|
let pb = PathBuf::from(p);
|
|
if pb.exists() && pb.is_dir() {
|
|
paths.push(pb);
|
|
}
|
|
}
|
|
}
|
|
|
|
// Respect $TMPDIR if it points somewhere else (e.g. custom Linux setups).
|
|
if let Ok(tmpdir) = std::env::var("TMPDIR") {
|
|
let pb = PathBuf::from(&tmpdir);
|
|
if pb.exists() && pb.is_dir() && !paths.contains(&pb) {
|
|
paths.push(pb);
|
|
}
|
|
}
|
|
|
|
paths
|
|
}
|
|
|
|
// ── Essential writable paths ────────────────────────────────────────────────
|
|
|
|
/// Writable directory paths for profiles that allow workspace writes (workspace, devbox, strict).
|
|
/// Device files are handled separately via `allow_file` in `to_capability_set_with_config`.
|
|
#[cfg(all(feature = "enforce", unix))]
|
|
pub(crate) fn essential_writable_paths(workspace: &Path) -> Vec<PathBuf> {
|
|
let mut paths = vec![workspace.to_path_buf(), kigi_home()];
|
|
paths.extend(temp_writable_paths());
|
|
paths
|
|
}
|
|
|
|
/// Writable directory paths for the read-only profile (minimal: just ~/.kigi + temp).
|
|
/// Device files are handled separately via `allow_file` in `to_capability_set_with_config`.
|
|
#[cfg(all(feature = "enforce", unix))]
|
|
pub(crate) fn essential_writable_paths_minimal() -> Vec<PathBuf> {
|
|
let mut paths = vec![kigi_home()];
|
|
paths.extend(temp_writable_paths());
|
|
paths
|
|
}
|