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).
140 lines
4.1 KiB
Rust
140 lines
4.1 KiB
Rust
//! Shared API definitions for Grok tools: protobuf types, config validation,
|
|
//! and canonical slash-command wording.
|
|
//!
|
|
//! Used by both the tools library and the gRPC server, and by host services
|
|
//! that must not depend on the tools implementation crate.
|
|
|
|
#![allow(clippy::derive_partial_eq_without_eq)]
|
|
|
|
/// Generated protobuf types.
|
|
pub mod pb {
|
|
include!(concat!(env!("OUT_DIR"), "/kigi.tools.v1.rs"));
|
|
}
|
|
|
|
pub mod config_validation;
|
|
pub mod slash_commands;
|
|
|
|
// Re-export commonly used types at the crate root for convenience
|
|
pub use pb::{
|
|
// Agent types
|
|
AgentCompletionRequirement,
|
|
AgentToolExecConfig,
|
|
AgentToolRetryConfig,
|
|
// Request/response types
|
|
ClearToolOverrideRequest,
|
|
ClearToolOverrideResponse,
|
|
DisableToolRequest,
|
|
DisableToolResponse,
|
|
EnableToolRequest,
|
|
EnableToolResponse,
|
|
// Enums
|
|
ErrorCode,
|
|
ExecuteToolRequest,
|
|
ExecuteToolResponse,
|
|
ExecutionMetadata,
|
|
ExecutionOptions,
|
|
FinalizeAgentRequest,
|
|
FinalizeAgentResponse,
|
|
FinalizeConfigValidationDetails,
|
|
FinalizeConfigViolation,
|
|
// Tool server config (finalize-time)
|
|
FinalizeToolServerConfigRequest,
|
|
FinalizeToolServerConfigResponse,
|
|
GetAgentInfoRequest,
|
|
GetAgentInfoResponse,
|
|
GetCompletionStateRequest,
|
|
GetCompletionStateResponse,
|
|
GetSystemPromptRequest,
|
|
GetSystemPromptResponse,
|
|
GetSystemRemindersRequest,
|
|
GetSystemRemindersResponse,
|
|
GetToolInfoRequest,
|
|
GetToolOptionsRequest,
|
|
GetToolOptionsResponse,
|
|
// Tool state
|
|
GetToolStateRequest,
|
|
GetToolStateResponse,
|
|
// Truncation config
|
|
GetTruncationConfigRequest,
|
|
GetTruncationConfigResponse,
|
|
ListToolsRequest,
|
|
ListToolsResponse,
|
|
// Output format specs
|
|
OutputFieldSpec,
|
|
OutputFormat,
|
|
OutputFormatSpec,
|
|
ResetCompletionStateRequest,
|
|
ResetCompletionStateResponse,
|
|
ResetToolOptionsRequest,
|
|
ResetToolOptionsResponse,
|
|
SetSystemRemindersRequest,
|
|
SetSystemRemindersResponse,
|
|
SetToolOptionsRequest,
|
|
SetToolOptionsResponse,
|
|
SetToolOverrideRequest,
|
|
SetToolOverrideResponse,
|
|
SetTruncationConfigRequest,
|
|
SetTruncationConfigResponse,
|
|
// Streaming types
|
|
StreamDataChunk,
|
|
StreamDataKind,
|
|
StreamFinalResult,
|
|
// Capability/metadata types
|
|
ToolCapabilities,
|
|
ToolCategory,
|
|
// Per-tool config entry
|
|
ToolConfigEntry,
|
|
ToolError,
|
|
ToolInfo,
|
|
ToolSource,
|
|
ToolStreamChunk,
|
|
ToolSuccess,
|
|
TruncationConfig,
|
|
// Version lifecycle warnings
|
|
VersionWarning,
|
|
};
|
|
|
|
/// Default client-facing tool name derived from a namespaced tool id.
|
|
///
|
|
/// Tool ids are colon-separated `Namespace:tool` (e.g. `GrokBuild:grep`); the
|
|
/// default name is the segment after the FIRST colon, so an id with embedded
|
|
/// colons (`ns:a:b`) resolves to `a`. Ids without a colon are returned as-is.
|
|
///
|
|
/// This is the single source of truth shared by the tools server (which
|
|
/// advertises tools under this name unless `name_override` is set) and any
|
|
/// client that needs to predict the advertised name from a config entry
|
|
/// (e.g. prompt tool selection in a downstream service). Keeping both sides on
|
|
/// this helper prevents a silent desync that would drop tools from prompts.
|
|
pub fn default_client_name(id: &str) -> &str {
|
|
id.split(':').nth(1).unwrap_or(id)
|
|
}
|
|
|
|
/// Convert ToolCategory enum to a string representation.
|
|
impl ToolCategory {
|
|
/// Get the string representation of the category.
|
|
pub fn as_str(&self) -> &'static str {
|
|
match self {
|
|
Self::Unspecified => "unspecified",
|
|
Self::File => "file",
|
|
Self::Search => "search",
|
|
Self::Shell => "shell",
|
|
Self::Workflow => "workflow",
|
|
Self::External => "external",
|
|
Self::Custom => "custom",
|
|
}
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod default_client_name_tests {
|
|
use super::default_client_name;
|
|
|
|
#[test]
|
|
fn pins_first_colon_derivation() {
|
|
assert_eq!(default_client_name("GrokBuild:grep"), "grep");
|
|
assert_eq!(default_client_name("ns:a:b"), "a");
|
|
assert_eq!(default_client_name("bare"), "bare");
|
|
assert_eq!(default_client_name(""), "");
|
|
}
|
|
}
|