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).
2026-07-17 05:31:01 -04:00
commit d6c20fc13f
2612 changed files with 1353757 additions and 0 deletions
@@ -0,0 +1,152 @@
+//! Tip of the Day — selection logic for tips served from remote settings.
+//!
+//! Tips are fetched at startup via `RemoteSettings.tips` (from `/v1/settings`).
+//! This module provides per-session rotation: each launch shows the next tip
+//! in sequence, cycling through all tips before repeating. The cursor is
+//! persisted to `~/.kigi/tip_cursor.json`.
+
+use std::path::{Path, PathBuf};
+
+use serde::{Deserialize, Serialize};
+
+const CURSOR_FILE: &str = "tip_cursor.json";
+
+/// Persistent state for tip rotation.
+#[derive(Debug, Default, Serialize, Deserialize)]
+struct TipState {
+    cursor: u64,
+}
+
+fn cursor_path(kigi_home: &Path) -> PathBuf {
+    kigi_home.join(CURSOR_FILE)
+}
+
+/// Load the cursor from `~/.kigi/tip_cursor.json`. Returns 0 on any error.
+fn load_cursor(kigi_home: &Path) -> u64 {
+    let text = match std::fs::read_to_string(cursor_path(kigi_home)) {
+        Ok(t) => t,
+        Err(_) => return 0,
+    };
+    serde_json::from_str::<TipState>(&text)
+        .map(|s| s.cursor)
+        .unwrap_or(0)
+}
+
+/// Save the cursor to `~/.kigi/tip_cursor.json`. Silently ignores write errors.
+fn save_cursor(kigi_home: &Path, cursor: u64) {
+    if let Ok(text) = serde_json::to_string(&TipState { cursor }) {
+        let _ = std::fs::write(cursor_path(kigi_home), text);
+    }
+}
+
+/// Pick the next tip for this session and advance the persistent cursor.
+///
+/// Each call returns the tip at `cursor % tips.len()` and increments the
+/// cursor in `~/.kigi/tip_cursor.json`, so every session sees the next tip
+/// in sequence. After all tips have been shown, the cycle repeats.
+///
+/// Returns `None` if `tips` is empty (cursor is not advanced in that case).
+pub fn pick_and_advance(tips: &[String], kigi_home: &Path) -> Option<String> {
+    if tips.is_empty() {
+        return None;
+    }
+    let cursor = load_cursor(kigi_home);
+    let tip = tips[cursor as usize % tips.len()].clone();
+    save_cursor(kigi_home, cursor + 1);
+    Some(tip)
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    // ── pick_and_advance ──────────────────────────────────────────────────────
+
+    #[test]
+    fn empty_list_returns_none() {
+        let dir = tempfile::tempdir().unwrap();
+        assert_eq!(pick_and_advance(&[], dir.path()), None);
+    }
+
+    #[test]
+    fn empty_list_does_not_advance_cursor() {
+        let dir = tempfile::tempdir().unwrap();
+        pick_and_advance(&[], dir.path());
+        assert_eq!(load_cursor(dir.path()), 0);
+    }
+
+    #[test]
+    fn single_tip_always_returned() {
+        let dir = tempfile::tempdir().unwrap();
+        let tips = vec!["only".to_string()];
+        assert_eq!(pick_and_advance(&tips, dir.path()).as_deref(), Some("only"));
+        assert_eq!(pick_and_advance(&tips, dir.path()).as_deref(), Some("only"));
+    }
+
+    #[test]
+    fn cycles_through_all_tips_in_order() {
+        let dir = tempfile::tempdir().unwrap();
+        let tips = vec!["a".to_string(), "b".to_string(), "c".to_string()];
+        assert_eq!(pick_and_advance(&tips, dir.path()).as_deref(), Some("a"));
+        assert_eq!(pick_and_advance(&tips, dir.path()).as_deref(), Some("b"));
+        assert_eq!(pick_and_advance(&tips, dir.path()).as_deref(), Some("c"));
+        // full cycle: wraps back to first
+        assert_eq!(pick_and_advance(&tips, dir.path()).as_deref(), Some("a"));
+    }
+
+    #[test]
+    fn cursor_persists_across_calls() {
+        let dir = tempfile::tempdir().unwrap();
+        let tips = vec!["x".to_string(), "y".to_string()];
+        pick_and_advance(&tips, dir.path()); // cursor → 1
+        assert_eq!(load_cursor(dir.path()), 1);
+        pick_and_advance(&tips, dir.path()); // cursor → 2
+        assert_eq!(load_cursor(dir.path()), 2);
+    }
+
+    #[test]
+    fn missing_cursor_file_starts_at_zero() {
+        let dir = tempfile::tempdir().unwrap();
+        let tips = vec!["first".to_string(), "second".to_string()];
+        assert_eq!(
+            pick_and_advance(&tips, dir.path()).as_deref(),
+            Some("first")
+        );
+    }
+
+    #[test]
+    fn handles_list_length_change_gracefully() {
+        let dir = tempfile::tempdir().unwrap();
+        // Start with 3 tips, advance cursor to 3
+        let tips3 = vec!["a".to_string(), "b".to_string(), "c".to_string()];
+        pick_and_advance(&tips3, dir.path()); // cursor 0 → 1
+        pick_and_advance(&tips3, dir.path()); // cursor 1 → 2
+        pick_and_advance(&tips3, dir.path()); // cursor 2 → 3
+
+        // remote settings pushes a 5-tip list; cursor=3, 3%5=3 → "d"
+        let tips5 = vec![
+            "a".to_string(),
+            "b".to_string(),
+            "c".to_string(),
+            "d".to_string(),
+            "e".to_string(),
+        ];
+        assert_eq!(pick_and_advance(&tips5, dir.path()).as_deref(), Some("d"));
+    }
+
+    // ── load_cursor / save_cursor ─────────────────────────────────────────────
+
+    #[test]
+    fn load_cursor_returns_zero_for_corrupt_file() {
+        let dir = tempfile::tempdir().unwrap();
+        std::fs::write(cursor_path(dir.path()), b"not json").unwrap();
+        assert_eq!(load_cursor(dir.path()), 0);
+    }
+
+    #[test]
+    fn save_and_load_roundtrip() {
+        let dir = tempfile::tempdir().unwrap();
+        save_cursor(dir.path(), 42);
+        assert_eq!(load_cursor(dir.path()), 42);
+    }
+}