Package Exports
- quantex-cli
- quantex-cli/package.json
Readme
Quantex CLI
项目定位:Quantex 是
human-friendly + agent-friendly的agent lifecycle CLI。主线聚焦 agent 的安装、检查、确保可用、更新、卸载、能力发现与稳定执行契约,不把自身扩张为 workflow orchestration platform。
设计文档
Project Memory
仓库现在开始采用一套面向 human + agent 协作、并为未来 agent 自主迭代预留的 repo-native 文档结构:
- docs/README.md
- docs/adr/
- docs/runbooks/
- docs/sessions/
- docs/github-collaboration.md
- autonomy/README.md
- openspec/README.md
现有根目录下的设计稿、scope 文档和 backlog 文档暂时保留为迁移期参考,映射关系见 docs/project-memory-migration.md。
Agent Skill
仓库内置了一份面向 Codex / agent 使用的 Quantex skill:
- skills/quantex-cli/SKILL.md
- skills/quantex-cli/references/command-recipes.md
- skills/quantex-cli/references/automation-playbook.md
- skills/quantex-cli/references/output-contracts.md
- skills/quantex-cli/references/troubleshooting.md
- skills/quantex-cli/scripts/smoke-check.sh
- docs/skill-installation-and-distribution.md
这份 skill 会引导 agent 以 Quantex 的 lifecycle CLI 方式工作,优先使用 inspect / ensure / resolve / exec / capabilities / commands / schema,并遵循结构化输出、非交互和自动化契约。
如果你在维护 Quantex 的命令面或 skill 本身,可以运行:
skills/quantex-cli/scripts/smoke-check.sh它会对 capabilities、commands、schema、inspect 以及可选的 resolve 做一轮轻量结构化 smoke check。
当前这份 skill 仍然是 repo-native artifact:支持随仓库共享、按仓库 revision 使用,或复制整个 skills/quantex-cli/ 目录到兼容的技能目录;还没有单独的 marketplace / package 发布流。细节见 docs/skill-installation-and-distribution.md。
支持的 Agent
| Agent | 命令 | 别名 | 描述 |
|---|---|---|---|
| Claude Code | quantex claude / qtx claude |
- | Anthropic 官方 AI 编程助手 CLI |
| Codex | quantex codex / qtx codex |
- | OpenAI 官方 AI 编程助手 CLI |
| Copilot | quantex copilot / qtx copilot |
- | GitHub Copilot 命令行工具 |
| Cursor | quantex cursor / qtx cursor |
agent |
Cursor AI 编程助手命令行工具 |
| Droid | quantex droid / qtx droid |
- | Factory AI 软件工程 Agent CLI |
| Gemini | quantex gemini / qtx gemini |
- | Google 开源 AI 编程助手 CLI |
| OpenCode | quantex opencode / qtx opencode |
- | 开源 AI 编程 CLI |
| Pi | quantex pi / qtx pi |
- | 极简可扩展的终端编程 Agent |
安装
# 使用 Bun
bun add -g quantex-cli
# 使用 npm
npm i -g quantex-cli也可以从 GitHub Releases 下载对应平台的独立二进制,或使用安装脚本:
curl -fsSL https://raw.githubusercontent.com/Drswith/quantex-cli/main/install.sh | shWindows PowerShell:
irm https://raw.githubusercontent.com/Drswith/quantex-cli/main/install.ps1 | iex安装后可使用 quantex 或短别名 qtx 命令。
使用
安装 Agent
quantex install claude
qtx i claude确保 Agent 已安装
quantex ensure claudeensure 是面向自动化和 agent 调用的幂等入口:
- 已安装则直接成功
- 未安装时才执行安装
- 配合
--json时会返回changed字段,便于上层判断是否发生变更
更新 Agent
quantex update claude
quantex u claude
quantex update --allquantex update 和 quantex update --all 现在共用同一套更新策略层:
managed:优先按 Quantex 已记录的安装来源更新self-update:使用 agent 自带的更新命令manual-hint:不自动更新,只给出明确提示
quantex update --all 会优先使用 ~/.quantex/state.json 里记录的实际安装来源进行批量更新:
bun会批量合并为一条bun update -g --latest ...npm会批量合并为一条npm install -g ...@latestbrew、winget会按记录的安装器标识逐个更新script、binary或仅在 PATH 中探测到但没有可自动更新能力的 agent 不会被错误并入托管更新命令
对于支持自更新的 agent,list、info、update 输出会明确显示 command update 或 self-update。
升级 Quantex CLI
quantex upgrade
# 只检查是否有更新
quantex upgrade --check
# 使用 beta channel
quantex upgrade --channel beta当前自身升级支持:
- 通过 Bun 全局安装的
quantex-cli - 通过 npm 全局安装的
quantex-cli - 通过独立二进制安装的
quantex
Binary 自升级具备:
- release manifest 解析
- SHA256 checksum 校验
- 升级锁
- post-upgrade verify
.bak最小回滚- Windows 延迟替换
如果升级失败,upgrade 和 doctor 都会给出与安装来源匹配的恢复方式。
卸载 Agent
quantex uninstall claude
quantex rm claude列出所有 Agent
quantex list
qtx lslist 会显示每个 agent 的安装状态、当前版本、更新方式和安装来源。例如:
managed update表示 Quantex 能按记录的安装器执行更新command update表示当前 agent 支持自更新manual update表示当前来源不支持自动更新managed via bun (...)、managed via brew (...)表示有明确来源记录detected in PATH表示命令存在,但不是由当前 Quantex 状态追踪到的安装
查看 Agent 详情
quantex info claudeinfo 会显示:
- 当前平台可用的安装方式
- 当前记录的安装来源与生命周期
- 当前版本和可检测到的最新版本
- agent 自带的自更新命令
查看 Agent 结构化状态
quantex inspect claude
quantex inspect claude --jsoninspect 更偏 agent-friendly,会集中返回:
- 安装状态、版本、路径、来源
- 当前 update mode
- 当前平台可用安装方式
auto-install/self-update/runnable等能力摘要
解析 Agent 可执行入口
quantex resolve claude
quantex resolve claude --jsonresolve 更偏 runtime-friendly,会直接返回:
- 当前可执行 binary 的绝对路径
- 已安装版本
- 安装来源
- 建议启动命令
快捷启动 Agent
quantex claude --dangerously-skip-permissions
qtx claude --dangerously-skip-permissions
quantex agent --help如果 agent 未安装,Quantex 会提示是否先安装再启动。
以显式策略启动 Agent
quantex exec claude --install if-missing -- --dangerously-skip-permissions
quantex exec codex --install never -- --helpexec 是比快捷启动更适合自动化的入口:
--install never:未安装时直接失败--install if-missing:缺失时自动安装再启动--install always:显式要求先满足安装前置,再启动
-- 之后的参数会原样透传给下游 agent,避免与 Quantex 自己的参数冲突。
Agent-friendly 全局参数
Quantex 现在默认保留 human-first CLI,同时补齐了一组统一的 agent-friendly 全局参数:
quantex inspect claude --json --refresh
quantex install claude --json --dry-run
quantex exec claude --install if-missing --yes -- --help当前主线支持:
--json/--output <human|json|ndjson>--non-interactive--yes--quiet--color <auto|always|never>--log-level <silent|error|warn|info|debug>--dry-run--refresh/--no-cache--run-id--idempotency-key--timeout
当 stdin 或 stdout 不是 TTY 时,Quantex 现在会自动切到 agent-friendly 默认行为:
- 自动关闭交互
- 默认改为结构化输出
不过在自动化里,仍然更建议显式传 --json、--output、--non-interactive,这样契约更清晰。
结构化输出的 stream contract 也已经固定下来:
human:面向人类阅读--json:stdout只输出最终 JSON envelope--output ndjson:stdout只输出事件流stderr:日志、警告和底层安装器输出
如果你需要精确查看输出结构,优先使用:
quantex commands --json
quantex schema --json
quantex schema inspect --json对于版本与 release 元数据查询,结构化结果的 meta 现在会附带:
fetchedAtstaleAftersource
这让上层 agent 可以判断结果是否来自缓存、何时应主动强刷。
配置管理
quantex config
quantex config get defaultPackageManager
quantex config set defaultPackageManager npm
quantex config set npmBunUpdateStrategy respect-semver
quantex config set selfUpdateChannel beta
quantex config reset环境检查
quantex doctordoctor 会检查:
bun、npm、brew、winget是否可用- Quantex CLI 自身的版本、安装来源、是否支持自动升级
- Quantex CLI 是否有新版本以及对应恢复方式
- 已安装 agent 的版本状态
- 当前环境是否缺少任何可用于托管安装/更新的安装器
查看能力探测结果
quantex capabilities
quantex capabilities --jsoncapabilities 和 doctor 的边界不同:
capabilities:回答“当前环境能做什么”doctor:回答“当前哪里有问题,以及怎么修”
查看命令目录
quantex commands
quantex commands --jsoncommands 会返回当前支持的稳定命令、摘要以及常用 flag,适合作为上层 agent 做 command discovery 的入口。
查看输出 Schema
quantex schema
quantex schema inspect --jsonschema 用来导出稳定命令的结构化输出定义,适合作为 agent 或 SDK 的类型参考。
配置
配置文件位于 ~/.quantex/config.json,当前支持:
{
"defaultPackageManager": "bun",
"npmBunUpdateStrategy": "latest-major",
"selfUpdateChannel": "stable",
"networkRetries": 2,
"networkTimeoutMs": 10000,
"versionCacheTtlHours": 6
}配置项说明:
defaultPackageManager:控制托管安装器的优先尝试顺序npmBunUpdateStrategy:latest-major:升级到 registry 最新版本,默认值respect-semver:保留包管理器默认的 semver 更新语义
selfUpdateChannel:Quantex CLI 自升级默认 channel,支持stable/betanetworkRetries:版本查询和 release 元数据请求重试次数networkTimeoutMs:网络请求超时时间versionCacheTtlHours:版本与 release 元数据缓存 TTL
状态文件
Quantex 会在 ~/.quantex/state.json 中记录运行时状态,例如:
- agent 的实际安装来源
- Quantex CLI 自身的安装来源
这个状态文件主要用于:
- 让
update --all能先生成更新计划,再按安装来源分组执行 - 避免混合安装场景下误用错误的更新方式
- 支撑
list、info、doctor、upgrade的来源判断和恢复提示
开发
bun install
bun run dev
bun run test
bun run test:watch
bun run lint
bun run lint:fix
bun run typecheck
bun run build
bun run build:bin
bun run release:artifactsrelease:artifacts 会统一生成并校验:
dist/bin/SHA256SUMS.txtdist/bin/manifest.json