Files
Kigi-CLI/crates/codegen/ptyctl-cli/src/cli.rs
T
ZacharyZhang-NY d6c20fc13f 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

228 lines
6.1 KiB
Rust

//! CLI argument definitions using clap derive.
use std::path::PathBuf;
use clap::{Parser, Subcommand};
#[derive(Parser)]
#[command(name = "ptyctl")]
#[command(about = "Run commands in PTY and control them via HTTP")]
#[command(version)]
#[command(arg_required_else_help = true)]
pub struct Cli {
#[command(subcommand)]
pub command: Commands,
}
#[derive(Subcommand)]
pub enum Commands {
/// Spawn a command in a PTY and start an HTTP control server
#[command(arg_required_else_help = true)]
Run {
/// Command to run (use -- before command)
#[arg(required = true, trailing_var_arg = true)]
command: Vec<String>,
/// Terminal width in columns
#[arg(short = 'W', long, default_value = "80")]
width: u16,
/// Terminal height in rows
#[arg(short = 'H', long, default_value = "24")]
height: u16,
/// Working directory
#[arg(short = 'c', long)]
cwd: Option<PathBuf>,
/// Environment variable (KEY=VAL, repeatable)
#[arg(short = 'e', long = "env", value_name = "KEY=VAL")]
env: Vec<String>,
/// TCP port to listen on (0 = auto-assign)
#[arg(short, long, default_value = "0")]
port: u16,
/// Session name (registers in ~/.local/state/ptyctl/sessions/)
#[arg(short, long)]
name: Option<String>,
/// Take over an existing session name (replaces the registration; does not stop the old server)
#[arg(long)]
force: bool,
/// Shutdown after N seconds
#[arg(short, long, value_name = "SECS")]
timeout: Option<u64>,
/// Keep server running after process exits
#[arg(short, long)]
linger: bool,
/// Suppress output (just print port number)
#[arg(short, long)]
quiet: bool,
},
/// Send keystrokes to a running session
#[command(arg_required_else_help = true)]
Send {
#[command(flatten)]
target: Target,
/// Keys to send (vim notation)
keys: String,
/// Append Enter (<CR>) after keys
#[arg(short = 'e', long)]
enter: bool,
},
/// Query terminal screen content
#[command(arg_required_else_help = true)]
Screen {
#[command(flatten)]
target: Target,
/// Row range, 1-indexed (e.g. "1:5")
#[arg(short, long)]
rows: Option<String>,
/// Column range, 1-indexed
#[arg(short = 'C', long)]
cols: Option<String>,
/// Output as JSON
#[arg(short, long, conflicts_with_all = ["ansi", "styled", "html"])]
json: bool,
/// Show cursor position with this character
#[arg(short = 'c', long)]
cursor: Option<char>,
/// Include ANSI escape codes
#[arg(short, long, conflicts_with_all = ["json", "styled", "html"])]
ansi: bool,
/// Output as styled JSON (LLM-friendly)
#[arg(short = 's', long, conflicts_with_all = ["json", "ansi", "html"])]
styled: bool,
/// Output as HTML
#[arg(long, conflicts_with_all = ["json", "ansi", "styled"])]
html: bool,
/// Include trailing empty lines
#[arg(long)]
full: bool,
/// Show line numbers
#[arg(short = 'l', long)]
line_numbers: bool,
},
/// Query process status
#[command(arg_required_else_help = true)]
Status {
#[command(flatten)]
target: Target,
},
/// Stop a running session
#[command(arg_required_else_help = true)]
Stop {
#[command(flatten)]
target: Target,
},
/// Resize terminal dimensions
#[command(arg_required_else_help = true)]
Resize {
#[command(flatten)]
target: Target,
/// New size as COLSxROWS (e.g. "120x40")
size: String,
},
/// Query cursor position
#[command(arg_required_else_help = true)]
Cursor {
#[command(flatten)]
target: Target,
},
/// Wait for a screen condition (event-driven, no polling).
/// Exit codes: 0 matched, 1 timeout (failure JSON on stdout), 2 usage/connection error
#[command(arg_required_else_help = true)]
#[command(group(clap::ArgGroup::new("condition").required(true)))]
Wait {
#[command(flatten)]
target: Target,
/// Wait until this text appears on screen
#[arg(long, group = "condition")]
text: Option<String>,
/// Wait until this regex matches the screen text
#[arg(long, group = "condition")]
regex: Option<String>,
/// Wait until this text is absent from the screen
#[arg(long, group = "condition")]
gone: Option<String>,
/// Wait until the screen has been unchanged for this many milliseconds
#[arg(long, value_name = "MS", group = "condition")]
stable_ms: Option<u64>,
/// Timeout in seconds (server caps at 120)
#[arg(short, long, default_value = "10")]
timeout: u64,
},
/// List registered sessions
List {
/// Output as JSON
#[arg(short, long)]
json: bool,
},
}
/// Target session — exactly one of host, port, or name must be provided.
#[derive(clap::Args)]
#[group(required = true, multiple = false)]
pub struct Target {
/// Remote host address (e.g. 127.0.0.1:8080)
#[arg(short = 'H', long)]
pub host: Option<String>,
/// Local server port
#[arg(short, long)]
pub port: Option<u16>,
/// Session name (from registry)
#[arg(short, long)]
pub name: Option<String>,
}
impl Target {
/// Resolve target to a base URL.
pub fn to_url(&self) -> anyhow::Result<String> {
if let Some(ref h) = self.host {
if h.starts_with("http") {
return Ok(h.clone());
}
return Ok(format!("http://{h}"));
}
if let Some(p) = self.port {
return Ok(format!("http://127.0.0.1:{p}"));
}
if let Some(ref n) = self.name {
let info = crate::registry::lookup_session(n)?;
return Ok(format!("http://127.0.0.1:{}", info.port));
}
anyhow::bail!("no target specified")
}
}