ZacharyZhang-NY
d6c20fc13f
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).
60 lines
2.7 KiB
Markdown
60 lines
2.7 KiB
Markdown
# Third-party vendored crates
|
||
|
||
This directory holds **upstream source** vendored into the repository. It is
|
||
**not** first-party application code.
|
||
|
||
## Why vendor
|
||
|
||
These crates sit on the path that renders **untrusted model output** (diagram
|
||
source → SVG). Vendoring gives a full audit surface, pins exact source, and
|
||
avoids crates.io yanks. Local patches and upgrade checklists live in each
|
||
crate’s `Cargo.toml` header comments — treat those as the source of truth when
|
||
re-vendoring.
|
||
|
||
## Mermaid layout stack
|
||
|
||
| Crate | Version | License | Upstream | Full license text |
|
||
|-------|---------|---------|----------|-------------------|
|
||
| [`mermaid-to-svg`](./mermaid-to-svg/) | (path) | MIT | [warpdotdev/mermaid-to-svg](https://github.com/warpdotdev/mermaid-to-svg) | [`LICENSE`](./mermaid-to-svg/LICENSE) |
|
||
| [`dagre_rust`](./dagre_rust/) | 0.0.5 | Apache-2.0 | [r3alst/dagre-rust](https://github.com/r3alst/dagre-rust) / Warp re-vendor | [`LICENCE`](./dagre_rust/LICENCE) |
|
||
| [`graphlib_rust`](./graphlib_rust/) | 0.0.2 | Apache-2.0 | [r3alst/graphlib-rust](https://github.com/r3alst/graphlib-rust) | [`LICENCE`](./graphlib_rust/LICENCE) |
|
||
| [`ordered_hashmap`](./ordered_hashmap/) | 0.0.3 | Apache-2.0 | [r3alst/ordered-hashmap](https://github.com/r3alst/ordered-hashmap) | [`LICENCE`](./ordered_hashmap/LICENCE) |
|
||
|
||
Dependency shape:
|
||
|
||
```text
|
||
xai-grok-mermaid
|
||
└── mermaid-to-svg (MIT)
|
||
├── dagre_rust (Apache-2.0)
|
||
│ ├── graphlib_rust
|
||
│ └── ordered_hashmap
|
||
└── graphlib_rust (Apache-2.0)
|
||
└── ordered_hashmap
|
||
```
|
||
|
||
## Notices and ancestry
|
||
|
||
- **[`NOTICE`](./NOTICE)** — short index of the crates above (names, licenses,
|
||
upstream links, paths to full text). Prefer that file for a one-page overview.
|
||
- **[`mermaid-to-svg/THIRD_PARTY_NOTICES`](./mermaid-to-svg/THIRD_PARTY_NOTICES)** —
|
||
additional ancestry for the SVG engine (e.g. mermaid.js, dagre.js MIT notices).
|
||
|
||
British spelling **`LICENCE`** is intentional on the Apache crates (as upstream
|
||
vendored); grepping only for `LICENSE` will miss them.
|
||
|
||
## crates.io dependencies
|
||
|
||
Normal Cargo dependencies (tokio, serde, …) are **not** under `third_party/`.
|
||
They resolve via `Cargo.lock` / crates.io. Full attribution and license texts
|
||
for the Grok CLI dependency closure are maintained in
|
||
[`THIRD-PARTY-NOTICES`](../THIRD-PARTY-NOTICES).
|
||
|
||
This directory is only for **in-tree vendored** sources.
|
||
|
||
## Upgrading
|
||
|
||
1. Read the `VENDORING NOTES` block at the top of the crate’s `Cargo.toml`.
|
||
2. Re-apply listed local patches (fmt, hermetic env, unsafe fixes, dropped bins/tests).
|
||
3. Confirm the license file still matches the declared `license =` field.
|
||
4. Refresh [`NOTICE`](./NOTICE) if versions or upstream URLs change.
|