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).
This commit is contained in:
ZacharyZhang-NY committed 2026-07-17 05:31:01 -04:00
commit d6c20fc13f
2612 files changed
+1353757

No files matched your search

@@ -0,0 +1,149 @@
//! Compaction mode — how much structure the model gets to recover detail the
//! lossy summary dropped. In `kigi-chat-state` so flag resolution and the
//! transcript-hint builder share one definition.
use crate::compaction_transcript::CompactionDetail;
/// How compaction exposes pre-compaction history to the model afterwards.
/// `Segments` carries its verbatim detail level inline, since detail is
/// meaningful only there.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, strum::Display)]
#[strum(serialize_all = "snake_case")]
pub enum CompactionMode {
/// Summary only — no pointer back to pre-compaction history. Default.
#[default]
Summary,
/// Summary + pointer to the full raw `updates.jsonl`.
Transcript,
/// Summary + a `compaction/` folder of clean per-segment markdown.
Segments(CompactionDetail),
}
impl CompactionMode {
/// Parse the mode word (case-insensitive); unknown → `None` so the caller
/// falls back. `segments` gets the default detail — callers override it via
/// [`CompactionMode::with_segment_detail`] once detail is resolved.
pub fn parse(s: &str) -> Option<Self> {
match s.trim().to_ascii_lowercase().as_str() {
"summary" => Some(Self::Summary),
"transcript" => Some(Self::Transcript),
"segments" => Some(Self::Segments(CompactionDetail::default())),
_ => None,
}
}
/// Replace the detail level if this is `Segments`, else unchanged. Lets the
/// resolver attach the separately-resolved `KIGI_COMPACTION_DETAIL`.
pub fn with_segment_detail(self, detail: CompactionDetail) -> Self {
match self {
Self::Segments(_) => Self::Segments(detail),
other => other,
}
}
pub fn segment_detail(self) -> Option<CompactionDetail> {
match self {
Self::Segments(d) => Some(d),
_ => None,
}
}
/// Whether this mode persists the `compaction/` segment store.
pub fn writes_segments(self) -> bool {
matches!(self, Self::Segments(_))
}
/// Transcript hint for the summary, given the one `location` this mode points
/// at (raw transcript path or `compaction/` folder). `None` if the mode adds
/// no pointer (`Summary`) or the location is absent.
pub fn transcript_hint(self, location: Option<&str>) -> Option<String> {
use crate::compaction_transcript::INDEX_FILE;
let loc = location?;
Some(match self {
Self::Summary => return None,
Self::Transcript => format!(
"\n\nIf you need specific details from before compaction \
(like exact code snippets, error messages, or content you \
generated), read the full transcript at: {loc}"
),
// Wording mirrors the segment-store continuation note.
Self::Segments(_) => format!(
"\n\nFull verbatim rollouts of previous segments are available \
at {loc}/segment_*.md. See {loc}/{INDEX_FILE} for a table of \
contents. Use read_file or grep to recover specific details \
(exact code, file paths, tool outputs) if this summary is \
insufficient. Do NOT modify these files."
),
})
}
}
#[cfg(test)]
mod tests {
use super::*;
/// `parse` is the public string contract (config + CLI): case-insensitive,
/// unknown ⇒ `None` so the caller falls back.
#[test]
fn parse_maps_names_and_rejects_unknown() {
assert_eq!(
CompactionMode::parse("summary"),
Some(CompactionMode::Summary)
);
assert_eq!(
CompactionMode::parse("transcript"),
Some(CompactionMode::Transcript)
);
// `segments` parses with the default detail; the resolver overrides it.
assert_eq!(
CompactionMode::parse(" SEGMENTS "),
Some(CompactionMode::Segments(CompactionDetail::default()))
);
assert_eq!(CompactionMode::parse("nonsense"), None);
assert_eq!(CompactionMode::default(), CompactionMode::Summary);
}
/// Detail is only attached to `Segments`; other modes ignore the override.
#[test]
fn with_segment_detail_only_affects_segments() {
assert_eq!(
CompactionMode::Segments(CompactionDetail::Verbose)
.with_segment_detail(CompactionDetail::Minimal),
CompactionMode::Segments(CompactionDetail::Minimal)
);
assert_eq!(
CompactionMode::Summary.with_segment_detail(CompactionDetail::Minimal),
CompactionMode::Summary
);
assert_eq!(
CompactionMode::Segments(CompactionDetail::Balanced).segment_detail(),
Some(CompactionDetail::Balanced)
);
assert_eq!(CompactionMode::Transcript.segment_detail(), None);
}
/// Contract: no hint for `Summary`, and never point the model at nothing.
#[test]
fn transcript_hint_needs_a_location() {
let segments = CompactionMode::Segments(CompactionDetail::default());
assert!(
CompactionMode::Summary
.transcript_hint(Some("/s/updates.jsonl"))
.is_none()
);
assert!(CompactionMode::Transcript.transcript_hint(None).is_none());
assert!(segments.transcript_hint(None).is_none());
assert!(
CompactionMode::Transcript
.transcript_hint(Some("/s/updates.jsonl"))
.unwrap()
.contains("/s/updates.jsonl")
);
assert!(
segments
.transcript_hint(Some("/s/compaction"))
.unwrap()
.contains("/s/compaction")
);
}
}