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).
118 lines
4.1 KiB
Rust
118 lines
4.1 KiB
Rust
//! Pure conversation-shape helpers, kept crate-neutral so both the session
|
|
//! layer (`kigi-shell`) and the `ChatStateActor` can share one definition
|
|
//! of "align the leading System message with a prompt".
|
|
|
|
use std::sync::Arc;
|
|
|
|
use kigi_sampling_types::conversation::ConversationItem;
|
|
|
|
/// Equal after trimming trailing `\n`/`\r` from both sides. Used for attach
|
|
/// idempotency so a stored head that differs from a client override only by a
|
|
/// trailing newline is treated as already matching (cache-friendly no-op).
|
|
/// Interior and leading whitespace are significant.
|
|
pub fn canonical_system_prompt_eq(a: &str, b: &str) -> bool {
|
|
a.trim_end_matches(['\n', '\r']) == b.trim_end_matches(['\n', '\r'])
|
|
}
|
|
|
|
/// Replace the leading `System` message with `prompt`, or insert one at the head
|
|
/// if the conversation has no leading `System`. Returns whether the conversation
|
|
/// changed; a head already equal to `prompt` (modulo trailing newlines) is left
|
|
/// untouched for KV-cache-friendly idempotency.
|
|
///
|
|
/// Single source of truth for the "align System[0] with the client override"
|
|
/// operation, shared by the cold-load pre-apply (on a loaded history `Vec`,
|
|
/// before spawn persists it) and the atomic `ChatStateActor` head swap that
|
|
/// backs the resident-reconnect path.
|
|
#[must_use]
|
|
pub fn replace_or_insert_system_head(
|
|
conversation: &mut Vec<ConversationItem>,
|
|
prompt: &str,
|
|
) -> bool {
|
|
match conversation.first_mut() {
|
|
Some(ConversationItem::System(sys)) => {
|
|
if canonical_system_prompt_eq(sys.content.as_ref(), prompt) {
|
|
return false;
|
|
}
|
|
sys.content = Arc::from(prompt);
|
|
true
|
|
}
|
|
_ => {
|
|
conversation.insert(0, ConversationItem::system(prompt));
|
|
true
|
|
}
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
|
|
fn system_prompt(conversation: &[ConversationItem]) -> Option<&str> {
|
|
conversation.first().and_then(|item| match item {
|
|
ConversationItem::System(s) => Some(s.content.as_ref()),
|
|
_ => None,
|
|
})
|
|
}
|
|
|
|
#[test]
|
|
fn canonical_system_prompt_eq_ignores_trailing_newlines() {
|
|
assert!(canonical_system_prompt_eq("hello\n", "hello"));
|
|
assert!(canonical_system_prompt_eq("hello\r\n", "hello"));
|
|
assert!(!canonical_system_prompt_eq("hello", "world"));
|
|
}
|
|
|
|
#[test]
|
|
fn canonical_system_prompt_eq_respects_interior_and_leading_whitespace() {
|
|
assert!(canonical_system_prompt_eq("a\nb\n", "a\nb"));
|
|
assert!(!canonical_system_prompt_eq("a\nb", "ab"));
|
|
assert!(!canonical_system_prompt_eq(" hello", "hello"));
|
|
}
|
|
|
|
#[test]
|
|
fn replace_or_insert_system_head_replaces_stored_head() {
|
|
let mut history = vec![
|
|
ConversationItem::system("default system prompt"),
|
|
ConversationItem::user("hi"),
|
|
];
|
|
assert!(replace_or_insert_system_head(
|
|
&mut history,
|
|
"client override"
|
|
));
|
|
assert_eq!(system_prompt(&history), Some("client override"));
|
|
assert_eq!(history.len(), 2, "must not wipe user turns");
|
|
}
|
|
|
|
#[test]
|
|
fn replace_or_insert_system_head_noop_when_unchanged() {
|
|
let mut history = vec![
|
|
ConversationItem::system("same prompt"),
|
|
ConversationItem::user("hi"),
|
|
];
|
|
assert!(!replace_or_insert_system_head(
|
|
&mut history,
|
|
"same prompt\n"
|
|
));
|
|
}
|
|
|
|
#[test]
|
|
fn replace_or_insert_system_head_inserts_when_first_is_not_system() {
|
|
let mut history = vec![ConversationItem::user("hi")];
|
|
assert!(replace_or_insert_system_head(
|
|
&mut history,
|
|
"client override"
|
|
));
|
|
assert_eq!(system_prompt(&history), Some("client override"));
|
|
assert_eq!(history.len(), 2, "inserts at head, keeps existing turns");
|
|
}
|
|
|
|
#[test]
|
|
fn replace_or_insert_system_head_inserts_into_empty() {
|
|
let mut history: Vec<ConversationItem> = vec![];
|
|
assert!(replace_or_insert_system_head(
|
|
&mut history,
|
|
"client override"
|
|
));
|
|
assert_eq!(system_prompt(&history), Some("client override"));
|
|
}
|
|
}
|