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).
182 lines
6.9 KiB
Rust
182 lines
6.9 KiB
Rust
//! Build script for bundling ripgrep for the kigi-tools crate.
|
|
//!
|
|
//! - If `KIGI_TOOLS_BUNDLE_RG_PATH` is set, always bundle it
|
|
//! - Otherwise, only bundle in release builds
|
|
use std::env;
|
|
use std::fs;
|
|
use std::io;
|
|
use std::path::PathBuf;
|
|
|
|
const RG_VER: &str = "15.0.0";
|
|
const BFS_VER: &str = "4.1";
|
|
const UGREP_VER: &str = "7.7.0";
|
|
|
|
fn main() -> Result<(), Box<dyn std::error::Error>> {
|
|
bundle_rg()?;
|
|
// bfs/ugrep back the bash-harness find/grep shadows (embedded_search_tools).
|
|
bundle_search_tool("bfs", "BFS", BFS_VER)?;
|
|
bundle_search_tool("ugrep", "UGREP", UGREP_VER)?;
|
|
Ok(())
|
|
}
|
|
|
|
/// Bundle a prebuilt **static** search-tool binary (`bfs`/`ugrep`) when
|
|
/// `KIGI_TOOLS_BUNDLE_<NAME>_PATH` points at one (supplied by the release
|
|
/// pipeline). Emits
|
|
/// `cfg(bundle_<name>)` so the crate's `include_bytes!` + self-extract engages.
|
|
///
|
|
/// No auto-download (unlike ripgrep): bfs/ugrep publish no prebuilt static
|
|
/// release assets, so the release pipeline supplies the path. Unset → not
|
|
/// bundled (the runtime resolver falls back to `~/.kigi/vendor` / `$PATH`);
|
|
/// never a hard failure, so an un-wired build still succeeds.
|
|
fn bundle_search_tool(
|
|
name: &str,
|
|
name_uc: &str,
|
|
ver: &str,
|
|
) -> Result<(), Box<dyn std::error::Error>> {
|
|
let override_env = format!("KIGI_TOOLS_BUNDLE_{name_uc}_PATH");
|
|
println!("cargo:rerun-if-env-changed={override_env}");
|
|
// Always declare the cfg so `#[cfg(bundle_<name>)]` is lint-clean when unset.
|
|
println!("cargo:rustc-check-cfg=cfg(bundle_{name})");
|
|
|
|
// The consumer (`embedded_search_tools`) is `#[cfg(unix)]`, so embedding on a
|
|
// Windows target is dead weight — skip (mirrors the ripgrep Windows skip).
|
|
if env::var("CARGO_CFG_TARGET_OS").as_deref() == Ok("windows") {
|
|
return Ok(());
|
|
}
|
|
|
|
let Some(src) = env::var(&override_env).ok().filter(|s| !s.is_empty()) else {
|
|
return Ok(());
|
|
};
|
|
|
|
let gen_dir = PathBuf::from(env::var("OUT_DIR")?).join(format!("bundle-{name}"));
|
|
fs::create_dir_all(&gen_dir)?;
|
|
let dest = gen_dir.join(format!("{name}-{ver}-override.bin"));
|
|
let _ = fs::remove_file(&dest);
|
|
fs::copy(&src, &dest)
|
|
.map_err(|e| format!("copy {override_env} from {src} to {}: {e}", dest.display()))?;
|
|
|
|
println!("cargo:rustc-cfg=bundle_{name}");
|
|
println!("cargo:rustc-env=KIGI_TOOLS_{name_uc}_VER={ver}");
|
|
println!("cargo:rustc-env=KIGI_TOOLS_{name_uc}_TARGET=override");
|
|
Ok(())
|
|
}
|
|
|
|
/// Download + embed ripgrep. Unchanged behavior; split out of `main` so the new
|
|
/// search-tool bundling runs regardless of ripgrep's early returns.
|
|
fn bundle_rg() -> Result<(), Box<dyn std::error::Error>> {
|
|
// Only bundle in release builds to avoid slowing down cargo check.
|
|
println!("cargo:rerun-if-env-changed=KIGI_TOOLS_BUNDLE_RG_PATH");
|
|
// Declare our custom cfg to the compiler so cfg(bundle_rg) is recognized by lints
|
|
println!("cargo:rustc-check-cfg=cfg(bundle_rg)");
|
|
|
|
let gen_dir = PathBuf::from(env::var("OUT_DIR")?).join("bundle-rg");
|
|
fs::create_dir_all(&gen_dir)?;
|
|
|
|
// Decide whether to bundle: path override OR release build
|
|
let path_override = env::var("KIGI_TOOLS_BUNDLE_RG_PATH").ok();
|
|
let is_release = env::var("PROFILE").as_deref() == Ok("release");
|
|
if path_override.is_none() && !is_release {
|
|
return Ok(());
|
|
}
|
|
|
|
// Skip auto-bundling on Windows: ripgrep ships .zip on Windows (not
|
|
// .tar.gz) and we have no zip-extraction path. Returning here BEFORE
|
|
// emitting `cargo:rustc-cfg=bundle_rg` keeps include_bytes! macros gated
|
|
// on cfg(bundle_rg) compiled-out, so the runtime falls back to `rg` on
|
|
// PATH. Users install ripgrep separately (winget / scoop). An explicit
|
|
// KIGI_TOOLS_BUNDLE_RG_PATH still bundles regardless of target.
|
|
let target_os = env::var("CARGO_CFG_TARGET_OS").unwrap_or_default();
|
|
if target_os == "windows" && path_override.is_none() {
|
|
return Ok(());
|
|
}
|
|
|
|
// Expose cfg so the crate can include the bundled bytes.
|
|
println!("cargo:rustc-cfg=bundle_rg");
|
|
println!("cargo:rustc-env=KIGI_TOOLS_RG_VER={}", RG_VER);
|
|
|
|
// If a local rg binary is provided, copy it directly (skips target check).
|
|
if let Some(path) = path_override {
|
|
let dest = gen_dir.join(format!("rg-{}-override.bin", RG_VER));
|
|
println!("cargo:rustc-env=KIGI_TOOLS_RG_TARGET=override");
|
|
let _ = fs::remove_file(&dest);
|
|
fs::copy(PathBuf::from(path.clone()), &dest).map_err(|e| {
|
|
format!(
|
|
"Failed copying KIGI_TOOLS_BUNDLE_RG_PATH: {e} from path {path} to dest {}",
|
|
dest.display()
|
|
)
|
|
})?;
|
|
return Ok(());
|
|
}
|
|
|
|
// Determine supported ripgrep asset triple for auto-download.
|
|
let target_arch = env::var("CARGO_CFG_TARGET_ARCH").unwrap_or_default();
|
|
let asset_triple = match (target_os.as_str(), target_arch.as_str()) {
|
|
("macos", "aarch64") => "aarch64-apple-darwin",
|
|
("macos", "x86_64") => "x86_64-apple-darwin",
|
|
("linux", "x86_64") => "x86_64-unknown-linux-musl",
|
|
("linux", "aarch64") => "aarch64-unknown-linux-gnu",
|
|
_ => {
|
|
return Err(format!(
|
|
"Unsupported target for ripgrep bundling: {os}-{arch}. Set KIGI_TOOLS_BUNDLE_RG_PATH to a local rg binary for offline or unsupported builds.",
|
|
os = target_os,
|
|
arch = target_arch
|
|
).into());
|
|
}
|
|
};
|
|
|
|
println!("cargo:rustc-env=KIGI_TOOLS_RG_TARGET={}", asset_triple);
|
|
let dest = gen_dir.join(format!("rg-{}-{}.bin", RG_VER, asset_triple));
|
|
let _ = fs::remove_file(&dest);
|
|
|
|
let url = format!(
|
|
"https://github.com/BurntSushi/ripgrep/releases/download/{v}/ripgrep-{v}-{t}.tar.gz",
|
|
v = RG_VER,
|
|
t = asset_triple
|
|
);
|
|
|
|
let bytes: Vec<u8> = {
|
|
let resp = reqwest::blocking::get(&url).map_err(|e| {
|
|
format!(
|
|
"Failed to download ripgrep: {}\nSet KIGI_TOOLS_BUNDLE_RG_PATH to a local rg for offline builds.",
|
|
e
|
|
)
|
|
})?;
|
|
if !resp.status().is_success() {
|
|
return Err(format!(
|
|
"HTTP {} downloading ripgrep. Set KIGI_TOOLS_BUNDLE_RG_PATH for offline builds.",
|
|
resp.status()
|
|
)
|
|
.into());
|
|
}
|
|
resp.bytes()?.to_vec()
|
|
};
|
|
|
|
let gz = flate2::read::GzDecoder::new(&bytes[..]);
|
|
let mut ar = tar::Archive::new(gz);
|
|
let mut found = false;
|
|
for entry in ar.entries()? {
|
|
let mut e = entry?;
|
|
let p = e.path()?;
|
|
if p.file_name().is_some_and(|n| n == "rg") {
|
|
let data: Vec<u8> = {
|
|
let mut v = Vec::new();
|
|
io::copy(&mut e, &mut v)?;
|
|
v
|
|
};
|
|
fs::write(&dest, &data)?;
|
|
found = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if !found {
|
|
return Err(format!(
|
|
"Could not find 'rg' in ripgrep archive {}. Set KIGI_TOOLS_BUNDLE_RG_PATH for offline builds.",
|
|
url
|
|
)
|
|
.into());
|
|
}
|
|
|
|
Ok(())
|
|
}
|