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:
@@ -0,0 +1,174 @@
|
||||
//! Default `Tool::execute` wrapping a blocking `Tool::run`.
|
||||
|
||||
use futures::StreamExt;
|
||||
use schemars::JsonSchema;
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use kigi_tool_protocol::ToolId;
|
||||
use kigi_tool_runtime::{
|
||||
Tool, ToolCallContext, ToolError, ToolErrorKind, ToolOutput, ToolStreamItem,
|
||||
};
|
||||
use kigi_tool_types::ToolDescription;
|
||||
|
||||
#[derive(Debug, Deserialize, Serialize, JsonSchema)]
|
||||
struct EchoArgs {
|
||||
text: String,
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize, PartialEq)]
|
||||
struct EchoOutput {
|
||||
text: String,
|
||||
}
|
||||
|
||||
impl ToolOutput for EchoOutput {}
|
||||
struct BlockingOk;
|
||||
|
||||
impl Tool for BlockingOk {
|
||||
type Args = EchoArgs;
|
||||
type Output = EchoOutput;
|
||||
|
||||
fn id(&self) -> ToolId {
|
||||
ToolId::new("blocking_ok").unwrap()
|
||||
}
|
||||
|
||||
fn description(&self, _ctx: &::kigi_tool_runtime::ListToolsContext) -> ToolDescription {
|
||||
ToolDescription::new("blocking_ok", "ok")
|
||||
}
|
||||
|
||||
async fn run(
|
||||
&self,
|
||||
_ctx: ToolCallContext,
|
||||
args: Self::Args,
|
||||
) -> Result<Self::Output, ToolError> {
|
||||
Ok(EchoOutput { text: args.text })
|
||||
}
|
||||
}
|
||||
|
||||
struct BlockingErr;
|
||||
|
||||
impl Tool for BlockingErr {
|
||||
type Args = EchoArgs;
|
||||
type Output = EchoOutput;
|
||||
|
||||
fn id(&self) -> ToolId {
|
||||
ToolId::new("blocking_err").unwrap()
|
||||
}
|
||||
|
||||
fn description(&self, _ctx: &::kigi_tool_runtime::ListToolsContext) -> ToolDescription {
|
||||
ToolDescription::new("blocking_err", "err")
|
||||
}
|
||||
|
||||
async fn run(
|
||||
&self,
|
||||
_ctx: ToolCallContext,
|
||||
args: Self::Args,
|
||||
) -> Result<Self::Output, ToolError> {
|
||||
Err(ToolError::invalid_arguments(format!(
|
||||
"rejected: {}",
|
||||
args.text
|
||||
)))
|
||||
}
|
||||
}
|
||||
|
||||
struct UnimplementedTool;
|
||||
|
||||
impl Tool for UnimplementedTool {
|
||||
type Args = EchoArgs;
|
||||
type Output = EchoOutput;
|
||||
|
||||
fn id(&self) -> ToolId {
|
||||
ToolId::new("unimplemented_tool").unwrap()
|
||||
}
|
||||
|
||||
fn description(&self, _ctx: &::kigi_tool_runtime::ListToolsContext) -> ToolDescription {
|
||||
ToolDescription::new("unimplemented_tool", "neither")
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn blocking_ok_wraps_into_single_terminal() {
|
||||
let tool = BlockingOk;
|
||||
let mut stream = tool
|
||||
.execute(
|
||||
ToolCallContext::default(),
|
||||
EchoArgs {
|
||||
text: "hello".into(),
|
||||
},
|
||||
)
|
||||
.await;
|
||||
let first = stream.next().await.expect("expected one item");
|
||||
assert!(first.is_terminal());
|
||||
match first {
|
||||
ToolStreamItem::Terminal(Ok(EchoOutput { text })) => assert_eq!(text, "hello"),
|
||||
other => panic!("expected Terminal(Ok), got {other:?}"),
|
||||
}
|
||||
assert!(stream.next().await.is_none(), "stream should be exhausted");
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn blocking_err_wraps_into_single_terminal() {
|
||||
let tool = BlockingErr;
|
||||
let mut stream = tool
|
||||
.execute(
|
||||
ToolCallContext::default(),
|
||||
EchoArgs {
|
||||
text: "rejected".into(),
|
||||
},
|
||||
)
|
||||
.await;
|
||||
let first = stream.next().await.expect("expected one item");
|
||||
match first {
|
||||
ToolStreamItem::Terminal(Err(ref err)) if err.kind == ToolErrorKind::InvalidArguments => {
|
||||
assert_eq!(err.detail, "rejected: rejected");
|
||||
}
|
||||
other => panic!("expected Terminal(Err(InvalidArguments)), got {other:?}"),
|
||||
}
|
||||
assert!(stream.next().await.is_none());
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn unimplemented_tool_returns_not_implemented_terminal() {
|
||||
let tool = UnimplementedTool;
|
||||
let item = tool
|
||||
.execute(ToolCallContext::default(), EchoArgs { text: "x".into() })
|
||||
.await
|
||||
.next()
|
||||
.await
|
||||
.unwrap();
|
||||
match item {
|
||||
ToolStreamItem::Terminal(Err(ref err))
|
||||
if err.kind == kigi_tool_runtime::error::ToolErrorKind::NotImplemented =>
|
||||
{
|
||||
assert!(
|
||||
err.detail.contains("run") && err.detail.contains("execute"),
|
||||
"detail should mention both methods, got: {}",
|
||||
err.detail
|
||||
);
|
||||
}
|
||||
other => panic!("expected Terminal(Err(NotImplemented)), got {other:?}"),
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn run_takes_args_by_value() {
|
||||
// The trait `run` consumes args; this would not compile if the
|
||||
// signature accidentally borrowed.
|
||||
let tool = BlockingOk;
|
||||
let args = EchoArgs {
|
||||
text: "consumed".into(),
|
||||
};
|
||||
let result = tool.run(ToolCallContext::default(), args).await.unwrap();
|
||||
assert_eq!(result.text, "consumed");
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn execute_default_drains_in_one_pass() {
|
||||
// A stream from the default impl should always have exactly one item.
|
||||
let tool = BlockingOk;
|
||||
let count = tool
|
||||
.execute(ToolCallContext::default(), EchoArgs { text: "n".into() })
|
||||
.await
|
||||
.count()
|
||||
.await;
|
||||
assert_eq!(count, 1);
|
||||
}
|
||||
Reference in New Issue
Block a user