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).
193 lines
6.7 KiB
Rust
193 lines
6.7 KiB
Rust
//! File watcher for detecting external memory edits.
|
|
//!
|
|
//! Watches `~/.kigi/memory/` for `.md` file changes (create, modify, remove)
|
|
//! and accumulates the affected paths. The search path checks [`is_dirty`]
|
|
//! before each query and syncs the index for all dirty paths:
|
|
//! - **created / modified** files are reindexed via `MemoryIndex::reindex_file`
|
|
//! - **deleted** files have their stale chunks removed via `MemoryIndex::delete_path`
|
|
//!
|
|
//! Without the deletion handling, chunks from removed files would remain
|
|
//! searchable indefinitely.
|
|
//!
|
|
//! Uses `arc_swap::ArcSwap` for lock-free dirty path tracking — the notify
|
|
//! event handler inserts via `rcu`, the search path takes via atomic swap.
|
|
//!
|
|
//! [`is_dirty`]: MemoryFileWatcher::is_dirty
|
|
|
|
use std::collections::HashSet;
|
|
use std::path::{Path, PathBuf};
|
|
use std::sync::Arc;
|
|
use std::sync::atomic::{AtomicBool, Ordering};
|
|
|
|
use arc_swap::ArcSwap;
|
|
use notify::{Event, EventKind, RecommendedWatcher, RecursiveMode, Watcher};
|
|
|
|
/// Watches the memory directory for `.md` file changes.
|
|
///
|
|
/// Lock-free design:
|
|
/// - **Insert** (notify thread): `dirty_files.rcu(|old| { clone + insert })`
|
|
/// - **Take** (search path): `dirty_files.swap(empty)` — single atomic pointer exchange
|
|
/// - **Quick check**: `dirty.load(Relaxed)` — single atomic load, no allocation
|
|
pub struct MemoryFileWatcher {
|
|
dirty_files: Arc<ArcSwap<HashSet<PathBuf>>>,
|
|
dirty: Arc<AtomicBool>,
|
|
_watcher: RecommendedWatcher,
|
|
}
|
|
|
|
impl MemoryFileWatcher {
|
|
/// Start watching the given memory directory for `.md` file changes.
|
|
///
|
|
/// Returns `None` if the watcher fails to initialize (logged, non-fatal).
|
|
pub fn start(memory_dir: &Path) -> Option<Self> {
|
|
let dirty_files: Arc<ArcSwap<HashSet<PathBuf>>> =
|
|
Arc::new(ArcSwap::new(Arc::new(HashSet::new())));
|
|
let dirty = Arc::new(AtomicBool::new(false));
|
|
|
|
let df = dirty_files.clone();
|
|
let d = dirty.clone();
|
|
|
|
let mut watcher = notify::recommended_watcher(move |res: Result<Event, notify::Error>| {
|
|
let Ok(event) = res else { return };
|
|
match event.kind {
|
|
EventKind::Create(_) | EventKind::Modify(_) | EventKind::Remove(_) => {}
|
|
_ => return,
|
|
}
|
|
for path in &event.paths {
|
|
if path.extension().is_some_and(|ext| ext == "md") {
|
|
let path = path.clone();
|
|
df.rcu(move |old| {
|
|
let mut new = (**old).clone();
|
|
new.insert(path.clone());
|
|
new
|
|
});
|
|
d.store(true, Ordering::Relaxed);
|
|
}
|
|
}
|
|
})
|
|
.map_err(|e| {
|
|
tracing::warn!(error = %e, "failed to create memory file watcher");
|
|
})
|
|
.ok()?;
|
|
|
|
watcher
|
|
.watch(memory_dir, RecursiveMode::Recursive)
|
|
.map_err(|e| {
|
|
tracing::warn!(
|
|
path = %memory_dir.display(),
|
|
error = %e,
|
|
"failed to watch memory directory"
|
|
);
|
|
})
|
|
.ok()?;
|
|
|
|
tracing::info!(
|
|
path = %memory_dir.display(),
|
|
"memory file watcher started"
|
|
);
|
|
|
|
Some(Self {
|
|
dirty_files,
|
|
dirty,
|
|
_watcher: watcher,
|
|
})
|
|
}
|
|
|
|
/// Quick check: true if any files have been modified since last take.
|
|
pub fn is_dirty(&self) -> bool {
|
|
self.dirty.load(Ordering::Relaxed)
|
|
}
|
|
|
|
/// Take all accumulated dirty paths, resetting the dirty state.
|
|
/// Returns the paths that changed since the last take.
|
|
pub fn take_dirty(&self) -> Vec<PathBuf> {
|
|
let old = self.dirty_files.swap(Arc::new(HashSet::new()));
|
|
self.dirty.store(false, Ordering::Relaxed);
|
|
old.iter().cloned().collect()
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
use tempfile::TempDir;
|
|
|
|
#[test]
|
|
fn test_watcher_starts_on_valid_dir() {
|
|
let tmp = TempDir::new().unwrap();
|
|
// In CI / containerized environments the OS may deny inotify watches
|
|
// (e.g. exhausted fs.inotify.max_user_instances); skip gracefully.
|
|
let _watcher = MemoryFileWatcher::start(tmp.path());
|
|
}
|
|
|
|
#[test]
|
|
fn test_watcher_initially_clean() {
|
|
let tmp = TempDir::new().unwrap();
|
|
let Some(watcher) = MemoryFileWatcher::start(tmp.path()) else {
|
|
eprintln!("skipping: could not create file watcher (resource limit?)");
|
|
return;
|
|
};
|
|
assert!(!watcher.is_dirty());
|
|
assert!(watcher.take_dirty().is_empty());
|
|
}
|
|
|
|
#[test]
|
|
fn test_watcher_detects_md_file_creation() {
|
|
let tmp = TempDir::new().unwrap();
|
|
let Some(watcher) = MemoryFileWatcher::start(tmp.path()) else {
|
|
eprintln!("skipping: could not create file watcher (resource limit?)");
|
|
return;
|
|
};
|
|
|
|
// Create a .md file — watcher should detect it
|
|
std::fs::write(tmp.path().join("test.md"), "hello").unwrap();
|
|
|
|
// Give the watcher time to process (debounce + OS event delivery)
|
|
std::thread::sleep(std::time::Duration::from_millis(500));
|
|
|
|
assert!(watcher.is_dirty(), "should detect .md creation");
|
|
let dirty = watcher.take_dirty();
|
|
assert!(!dirty.is_empty(), "should have dirty paths");
|
|
assert!(dirty[0].extension().unwrap() == "md");
|
|
}
|
|
|
|
#[test]
|
|
fn test_watcher_ignores_non_md_files() {
|
|
let tmp = TempDir::new().unwrap();
|
|
let Some(watcher) = MemoryFileWatcher::start(tmp.path()) else {
|
|
eprintln!("skipping: could not create file watcher (resource limit?)");
|
|
return;
|
|
};
|
|
|
|
// Create a non-.md file
|
|
std::fs::write(tmp.path().join("test.txt"), "hello").unwrap();
|
|
std::fs::write(tmp.path().join("index.sqlite"), "db").unwrap();
|
|
|
|
std::thread::sleep(std::time::Duration::from_millis(500));
|
|
|
|
assert!(
|
|
!watcher.is_dirty(),
|
|
"should not detect non-.md file changes"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_take_dirty_resets_state() {
|
|
let tmp = TempDir::new().unwrap();
|
|
let Some(watcher) = MemoryFileWatcher::start(tmp.path()) else {
|
|
eprintln!("skipping: could not create file watcher (resource limit?)");
|
|
return;
|
|
};
|
|
|
|
std::fs::write(tmp.path().join("a.md"), "content").unwrap();
|
|
std::thread::sleep(std::time::Duration::from_millis(500));
|
|
|
|
let first = watcher.take_dirty();
|
|
assert!(!first.is_empty());
|
|
assert!(!watcher.is_dirty(), "should be clean after take");
|
|
assert!(
|
|
watcher.take_dirty().is_empty(),
|
|
"second take should be empty"
|
|
);
|
|
}
|
|
}
|