Replies: 1 comment
-
|
This decision has been promoted into durable repo-native and GitHub delivery artifacts:
I'm closing this discussion now that the actionable work and the split follow-up are both captured in the repository workflow. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Decision space
围绕本仓库
README.md的呈现策略需要做三个决定:qtx作为 README 中推荐的主入口?当前quantex在文案、Quick Start、命令表、Agent 表里全面占据主导,qtx仅在文末以 footnote 出现,这与"项目实际更推荐qtx"的倾向不一致。package.json#bin同时声明了quantex与qtx,技术上npx -p quantex-cli qtx ...已可直接使用,但 README 仅在"Agent 快速接入"一节出现过一次类似命令,普通终端用户会误以为必须先全局安装。Copy-Item复制quantex.exe -> qtx.exe(POSIX 是 symlink)。这影响 self upgrade 时是否同步替换qtx.exe、卸载时是否同步删除、以及process.argv[0]行为的一致性。讨论上下文还包含对 README 与 Drswith/vanilla-jsx README 的对比评审,得出的可借鉴点(Features 块、可跑的 Quick Start、每个能力配示例、Contributing 独立成节、TOC)会随本决定一并落到 README 改造中,但不是本决定本身要拍板的内容。
Constraints
human-friendly + agent-friendly的 agent lifecycle CLI,不扩张为 workflow orchestration platform。package.json#bin两个名字 (quantex/qtx) 不能轻易移除,npm/Bun 用户当前命令习惯不能破坏。quantex与qtx:npm i -g quantex-cli/bun add -g quantex-cli:包管理器 shim。install.sh:qtx是quantex的 symlink。install.ps1:qtx.exe是quantex.exe的Copy-Item副本。npx -p quantex-cli .../bunx quantex-cli ...:临时 shim 路径。~/.quantex/state.json中self.installSource在二进制脚本里只在quantex端落盘;npx 路径不写状态,需要在文档里诚实标注。README.en.md与skills/quantex-cli/SKILL.md,避免 surface 漂移。Tradeoffs
决定 1:
qtx是否成为推荐主入口quantex主,qtxfootnote)qtx主(命令表、Quick Start、Agent 表全部改qtx)qtx不如quantex自我解释;存量用户文档/笔记里仍是quantex,认知漂移。qtx优先(推荐)qtx,常用命令表用 "qtx i/quantex install" 双列共陈,文档其它处段保留quantex增加可搜索性。qtx,等价于quantex"。决定 2:免安装试用是否成为一等公民
npm exec)quantex doctor / list / info / inspect / capabilities这些只读命令本就适合 npx。list/info/doctor/inspect/capabilities),明确建议安装、更新、卸载等会写状态的命令仍走全局安装。npx -p quantex-cli qtx ...、bunx quantex-cli ...、pnpm dlx quantex-cli ...等价命令。install/update --all后,下一次本地执行时state.json里self.installSource可能与实际不一致——文档需要明确标注。state.json/ self upgrade 设计冲突,违背 AGENTS.md 中"记住真实安装来源"的能力承诺。决定 3(邻接):Windows 二进制双副本的一致性
Copy-Item复制qtx.exe)qtx.exe(推荐方向)src/self/binary.ts与 Windows delayed replacement 流程中确认:升级时同步替换qtx.exe,并在 README/runbook 中列出双文件清理步骤。Proposed ADR title
qtxas the recommended primary CLI entry point in user-facing documentationnpx -p quantex-cli qtx ...for read-only commandsqtx.execonsistent withquantex.exeacross self upgrade and uninstallNext step
按 AGENTS.md "Work Intake Gate":
README.md/README.en.md/skills/quantex-cli/SKILL.md。Beta Was this translation helpful? Give feedback.
All reactions