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:
commit
d6c20fc13f
2612 files changed
+1353757
No files matched your search
@@ -0,0 +1,106 @@
|
||||
//! Per-tool capabilities and notification schemas.
|
||||
|
||||
use std::collections::HashMap;
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
/// Per-tool wire-traveling capabilities. Defaults conservatively (no
|
||||
/// progress, no cancel, single concurrency, no hooks).
|
||||
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
|
||||
pub struct ToolCapabilities {
|
||||
/// Streaming declaration. `None` — the default for every tool today —
|
||||
/// means the tool never emits partial-result progress.
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub streaming: Option<StreamingSpec>,
|
||||
|
||||
/// Tool honours `hook { Cancel }`.
|
||||
#[serde(default)]
|
||||
pub supports_cancel: bool,
|
||||
|
||||
/// Maximum concurrent invocations the tool will accept. `None` is
|
||||
/// unlimited.
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub max_concurrency: Option<u32>,
|
||||
|
||||
/// Mirrors `Tool::is_read_only`; used by doom-loop detection.
|
||||
#[serde(default)]
|
||||
pub is_read_only: bool,
|
||||
|
||||
/// Lifecycle hooks the tool opts in to receive.
|
||||
#[serde(default, skip_serializing_if = "Vec::is_empty")]
|
||||
pub hooks: Vec<HookKind>,
|
||||
|
||||
/// Opaque per-tool behaviour version. Bytewise-compared (NOT semver).
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub behavior_version: Option<String>,
|
||||
|
||||
/// Per-tool override for the per-frame size cap. Service clamps to the
|
||||
/// 16 MiB hard ceiling.
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub max_frame_bytes: Option<u32>,
|
||||
|
||||
/// Per-call timeout override (defaults to 60_000ms when omitted).
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub timeout_ms: Option<u64>,
|
||||
|
||||
/// Multi-agent write-coordination scope. Tools that mutate external
|
||||
/// state must declare `Write` so the computer hub routes them to the
|
||||
/// leader agent only. Absence is treated as `Read`.
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub tool_scope: Option<ToolScope>,
|
||||
}
|
||||
|
||||
/// How a tool streams partial results. Declared once in
|
||||
/// [`ToolCapabilities::streaming`] and consumed at the source to stamp a
|
||||
/// self-describing progress envelope; downstream layers dispatch on that
|
||||
/// envelope rather than the tool's identity.
|
||||
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
|
||||
pub struct StreamingSpec {
|
||||
/// Stable snake_case discriminator the tool stamps on its
|
||||
/// `ToolProgress::Custom.subkind` (e.g. `"bash_output_chunk"`).
|
||||
pub subkind: String,
|
||||
|
||||
/// Per-frame `delta` byte cap (UTF-8-safe). Unset falls back to the
|
||||
/// runtime's 16 KiB default. Independent of
|
||||
/// [`ToolCapabilities::max_frame_bytes`], which caps whole frames.
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub max_delta_bytes: Option<u32>,
|
||||
}
|
||||
|
||||
/// Lifecycle hook a tool may opt in to receive.
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
|
||||
#[serde(rename_all = "snake_case")]
|
||||
pub enum HookKind {
|
||||
OnSessionOpen,
|
||||
OnSessionClose,
|
||||
OnToolCallStart,
|
||||
OnToolCallResult,
|
||||
OnCancel,
|
||||
OnNotification,
|
||||
}
|
||||
|
||||
/// Multi-agent write-coordination scope.
|
||||
///
|
||||
/// Tools that mutate external state must declare `Write` so the computer hub
|
||||
/// routes them to the leader agent only. Absence is treated as `Read`.
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
|
||||
#[serde(rename_all = "snake_case")]
|
||||
pub enum ToolScope {
|
||||
/// Tool does not mutate external state.
|
||||
Read,
|
||||
/// Tool mutates external state.
|
||||
Write,
|
||||
}
|
||||
|
||||
/// Per-tool notification schemas. Keys are the notification `kind` strings
|
||||
/// the computer hub validates against.
|
||||
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
|
||||
pub struct NotificationSchemas {
|
||||
/// Schemas for notifications the tool emits to subscribers.
|
||||
#[serde(default, skip_serializing_if = "HashMap::is_empty")]
|
||||
pub outbound: HashMap<String, serde_json::Value>,
|
||||
|
||||
/// Schemas for notifications the harness sends to the tool.
|
||||
#[serde(default, skip_serializing_if = "HashMap::is_empty")]
|
||||
pub inbound: HashMap<String, serde_json::Value>,
|
||||
}
|
||||
Reference in new issue
Block a user