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).
125 lines
4.9 KiB
Rust
125 lines
4.9 KiB
Rust
//! Session summary (title) generation lifecycle.
|
|
//!
|
|
//! Encapsulates the full lifecycle: check if a summary already exists,
|
|
//! generate one via the LLM, persist it, sync to remote, update the
|
|
//! session registry, and notify the client. The persistence actor just
|
|
//! calls [`SummaryGenerator::update`] — all state transitions are internal.
|
|
|
|
use crate::extensions::notification::{SessionNotification, SessionUpdate as XaiSessionUpdate};
|
|
use crate::sampling::Client as OaiCompatClient;
|
|
use crate::session::helpers::session_summary::generate_session_summary;
|
|
use crate::session::info::Info;
|
|
use crate::session::persistence::PersistenceMsg;
|
|
use agent_client_protocol as acp;
|
|
use kigi_acp_lib::AcpAgentGatewaySender as GatewaySender;
|
|
use tokio::sync::mpsc;
|
|
|
|
/// Internal state for the summary generation lifecycle.
|
|
enum State {
|
|
/// No summary generated yet. Will attempt on the next [`SummaryGenerator::update`] call.
|
|
Idle,
|
|
/// Summary generation has been attempted (spawned or already on disk). No further work needed.
|
|
Done,
|
|
}
|
|
|
|
/// Dependencies for session title generation and fan-out.
|
|
pub(crate) struct SummaryConfig {
|
|
pub(crate) sampling_client: OaiCompatClient,
|
|
pub(crate) model: String,
|
|
/// Channel back to the persistence actor for sequential storage writes.
|
|
pub(crate) persistence_tx: mpsc::UnboundedSender<PersistenceMsg>,
|
|
}
|
|
|
|
/// Manages session title generation with explicit lifecycle state.
|
|
///
|
|
/// Created once per persistence actor. The only public method is [`update`],
|
|
/// which is called from the `ContentChunk` handler. Internally it transitions
|
|
/// through `Idle -> Done`, spawning the LLM call as a background task and
|
|
/// routing the result back through the persistence channel for storage.
|
|
pub(crate) struct SummaryGenerator {
|
|
state: State,
|
|
config: SummaryConfig,
|
|
}
|
|
|
|
impl SummaryGenerator {
|
|
pub(crate) fn new(config: SummaryConfig) -> Self {
|
|
Self {
|
|
state: State::Idle,
|
|
config,
|
|
}
|
|
}
|
|
|
|
/// Generate a session summary from the first content chunk.
|
|
///
|
|
/// - **Idle**: checks disk for an existing summary, spawns a background
|
|
/// task for LLM title generation so the persistence actor is not blocked.
|
|
/// Empty content is skipped (stays Idle) so the next chunk can retry.
|
|
/// - **Done**: no-op.
|
|
pub(crate) fn update(&mut self, content: String) {
|
|
match self.state {
|
|
State::Done => {}
|
|
State::Idle => {
|
|
// No text to generate a title from (e.g. image-only message).
|
|
// Stay Idle so the next ContentChunk with actual text retries.
|
|
if content.trim().is_empty() {
|
|
return;
|
|
}
|
|
|
|
// Transition to Done so subsequent ContentChunk messages
|
|
// don't spawn duplicate title generation tasks.
|
|
self.state = State::Done;
|
|
|
|
let sampling_client = self.config.sampling_client.clone();
|
|
let model = self.config.model.clone();
|
|
let persistence_tx = self.config.persistence_tx.clone();
|
|
|
|
// Spawn title generation as a background task so the
|
|
// persistence actor can continue processing messages
|
|
// (updates, flushes) without waiting for the LLM call.
|
|
tokio::spawn(async move {
|
|
let mut title =
|
|
generate_session_summary(content.clone(), sampling_client, &model).await;
|
|
if title.trim().is_empty() {
|
|
title =
|
|
crate::session::helpers::session_summary::title_fallback_from_user_text(
|
|
&content,
|
|
);
|
|
}
|
|
|
|
// Route the result through the persistence channel. The
|
|
// actor persists it (only if the session has no title yet)
|
|
// and notifies the client there, so a title rejected for
|
|
// racing a manual `/rename` never reaches the client.
|
|
let _ = persistence_tx.send(PersistenceMsg::GeneratedTitle(title));
|
|
});
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Mark as Done (e.g. when disk already has a summary during load).
|
|
pub(crate) fn mark_done(&mut self) {
|
|
self.state = State::Done;
|
|
}
|
|
}
|
|
|
|
/// Notify the client that a session summary is available.
|
|
pub(crate) fn notify_client(gateway: &Option<GatewaySender>, info: &Info, title: &str) {
|
|
let Some(gateway) = gateway else {
|
|
return;
|
|
};
|
|
|
|
let notification = SessionNotification {
|
|
session_id: info.id.clone(),
|
|
update: XaiSessionUpdate::SessionSummaryGenerated {
|
|
session_summary: title.to_owned(),
|
|
},
|
|
meta: None,
|
|
};
|
|
if let Ok(params) = serde_json::value::to_raw_value(¬ification) {
|
|
gateway.forward_fire_and_forget(acp::ExtNotification::new(
|
|
"x.ai/session_notification",
|
|
params.into(),
|
|
));
|
|
}
|
|
}
|