docs: 规范 stdin 直接 heredoc 输入

2026-07-12 04:31:58 +02:00
parent 9fe7a1c7e9
commit 14fa5b4b4b
2 changed files with 11 additions and 1 deletions
@@ -10,6 +10,12 @@ UniDesk 的统一 CLI 实现入口是根目录 `scripts/cli.ts`，运行方式
  - 默认输出或帮助输出触发 dump 视为 CLI 缺陷，必须收敛信息结构，禁止用提高 stdout 阈值掩盖。
  - dump 只允许用于用户显式请求的 `--full`、`--raw`、机器完整输出，或确实无法预先界定的一次性异常证据。

+- stdin 文本输入默认直接使用 quoted heredoc：
+  - 单次使用的正文、评论、prompt、patch、脚本或 JSON 必须直接写成 `--*-stdin <<'EOF'` 或等价 stdin heredoc。
+  - 禁止先把同一段文本写入 `/tmp` 或工作区临时文件，再用 `< file` 传给支持 stdin 的命令。
+  - 只有内容需要复用、作为正式工件保留、属于二进制，或目标工具明确只接受文件路径时，才使用 `--*-file`、upload 或文件重定向。
+  - heredoc delimiter 必须引用，避免 `$()`、反引号、变量和反斜杠被本地 shell 提前展开。
+
 主 server 必须在 PATH 上提供 `/root/.local/bin/trans` 可执行 wrapper，内容委托 repo 内版本化 `scripts/trans` 并执行 `bun scripts/ssh-cli.ts ssh "$@"`；交互 shell 可额外提供 alias，但非交互 Codex `exec` 和脚本不能依赖 alias 展开。

 主 server 固定提供 PATH 可见的 `/usr/local/bin/unidesk`，委托版本化 `scripts/unidesk` 执行根 CLI；`/root/.local/bin/unidesk` 可以保留为用户级兼容链接，但不能作为非交互入口的唯一安装位置。高频人工入口优先写 `unidesk <command>`；仓库内验证和未安装 wrapper 的 checkout 使用等价的 `bun scripts/cli.ts <command>`。