@laivc/laicode 0.0.1 → 0.2.0

package/README.md

@@ -1,11 +1,149 @@
-# LaiCode
-
-LaiCode is the official CLI for configuring local developer tools to use the Lai.vc API gateway.
+# LaiCode CLI
 
 ```bash
 npm install -g @laivc/laicode
-laicode --help
+laicode
+```
+
+LaiCode is the official CLI testbench for the Lai.vc API gateway.
+
+The interface defaults to Chinese and uses terminal panels/tables that handle CJK alignment correctly.
+Its terminal cockpit follows the Lai.vc brand palette: plum, coral, persimmon, ivory, and gold.
+Network and model calls use TTY-aware loading animations. JSON output and non-interactive shell usage stay clean.
+
+## Commands
+
+```bash
+laicode                 # interactive console
+laicode --fancy          # arrow-key console where supported
+laicode brand            # brand mark and palette preview
+laicode status           # live cockpit snapshot
+laicode status --refresh # bypass the short dashboard cache
+laicode commands         # command catalog
+laicode completion bash  # print shell completion script
+laicode tools            # inspect local AI tools
+laicode init --tool codex # preview a one-click Codex profile
+laicode init --tool codex --apply
+laicode rollback         # undo the latest Laicode config write
+laicode login
+laicode models --online
+laicode chat --model gpt-5.5 --message "Say hello"
+laicode bench --model gpt-5.5 --count 3
+laicode bench --model gpt-5.5 --count 3 --json
+laicode doctor
+laicode doctor --json
+laicode keys
+laicode config
+laicode logout
+```
+
+Local state is stored in `~/.laicode` by default. LaiCode does not modify your existing Claude, ChatGPT, Cursor, Codex, Cline, or Continue configuration in this phase.
+When logged in, the interactive cockpit shows live account status, online model count, balance, request count, gateway URL, and npm release status. Cockpit snapshots use a short local cache so returning to the menu stays fast.
+
+## First Run
+
+```bash
+laicode status
+laicode login
+laicode models --online
+laicode doctor
+laicode tools
+laicode init --tool codex
+```
+
+`status` shows the next recommended actions when the local state is empty.
+
+## Radar and Benchmark
+
+`laicode models --online` shows a radar summary before the model table: online coverage, vendor count, available tiers, recommended default model, cheapest input tier, and fastest reported latency.
+
+`laicode bench` uses streaming requests and reports per-run first-token latency, total latency bars, success rate, P50/P95, jitter, and estimated throughput.
+
+Use `laicode bench --json` for script-friendly health checks. The JSON output includes model, timing summary, per-run result rows, timestamps, and prompt length, but no local token or API key.
+
+Use `laicode doctor --json` for CI-friendly diagnostics across local state, catalog reachability, npm version status, CLI session, API key, and a real chat completion check.
+
+## Local Tool Onboarding
+
+Phase 1 focuses on checking local AI tools and safely connecting them to Lai.vc.
+
+```bash
+laicode tools
+laicode init --tool codex
+laicode init --tool codex --apply
+codex --profile laicode
+laicode rollback
+```
+
+`init` previews the files it would write by default. `--apply` creates a backup under `~/.laicode/backups` before writing, and `rollback` restores the latest Laicode-managed write.
+
+The first automatic adapter creates `~/.codex/laicode.config.toml` instead of modifying the main Codex config. Continue can create a fresh `~/.continue/config.yaml` when no existing Continue config is present. Cursor and Cline are currently inspected with guided setup to avoid unsafe writes into app-managed secure storage.
+
+The Codex profile uses Codex's command-backed auth to call `laicode credential api-key`, so the Lai.vc key stays in `~/.laicode` instead of being copied into Codex config.
+
+完整 API Key 默认不会显示。若确实需要查看，使用:
+
+```bash
+laicode keys --show
+```
+
+非交互环境需要显式确认:
+
+```bash
+laicode keys --show --yes
+```
+
+`keys --json` 默认不输出任何 key 片段；需要完整 key 时必须显式使用 `--show --yes`。
+
+## Terminal Options
+
+```bash
+laicode --plain      # disable color styling
+laicode --color      # force color even when NO_COLOR is set
+laicode --fancy      # experimental arrow-key menu
+laicode --color brand # preview the Lai.vc terminal palette
+laicode status --json # script-friendly status output without secret fragments
+laicode doctor --json # script-friendly diagnostics
+laicode config --json # script-friendly local config summary
+laicode commands --json # machine-readable command catalog
+```
+
+## Shell Completion
+
+```bash
+laicode completion bash
+laicode completion zsh
+laicode completion fish
+laicode completion powershell
+```
+
+The command prints a completion script to stdout and does not modify your shell profile.
+
+Environment variables:
+
+```bash
+LAICODE_HOME=/path/to/state    # default: ~/.laicode
+LAICODE_SITE_URL=https://lai.vc
+LAICODE_PLAIN=1               # disable styling
+LAICODE_COLOR=1               # force color preview/output
+LAICODE_NO_SPINNER=1          # disable loading animations
+```
+
+## Manual API Key Mode
+
+If you already have a Lai.vc key:
+
+```bash
+laicode config set api-key sk-...
+laicode config set base-url https://api.lai.vc/v1
+laicode chat --model gpt-5.5 --message "Test Lai.vc"
 ```
 
-This first package reserves the official CLI name while the full cross-platform configurator is being built.
+## Maintainers
+
+```bash
+npm run release:check
+npm publish
+```
 
+`release:check` runs syntax checks, smoke tests, and an npm publish dry-run.