CLI 命令参考
XHSSpec CLI 提供 12 个核心命令，覆盖从初始化到归档的完整工作流。
初始化
| 命令 | 作用 | 常用示例 |
|---|---|---|
init | 初始化工作区，安装必要配置 | xhs-spec init --tools claude-code |
doctor | 检查环境健康度 | xhs-spec doctor |
init 会创建 .xhsspec/ 目录结构，并安装宿主集成文件（CLAUDE.md、AGENTS.md 等）。
doctor 检查配置完整性、errors/warnings 数量、最近 run 状态。
创建内容
| 命令 | 作用 | 常用示例 |
|---|---|---|
quick | 单篇快速笔记 | xhs-spec quick --idea "程序员如何用AI做周报" |
hot | 热点响应 | xhs-spec hot --topic "OpenAI新模型发布" |
plan | 策划 Campaign | xhs-spec plan --theme "AI效率工具" --count 3 |
quick
bash
# 最简用法
xhs-spec quick --idea "程序员如何用AI做周报"
# 完整参数
xhs-spec quick --idea "..." --angle "角度" --cta "引导互动" --id quick-001hot
bash
xhs-spec hot --topic "热点话题" --source "来源"plan
bash
xhs-spec plan --theme "AI效率工具" --goal growth --count 3 --window weekly| 参数 | 说明 |
|---|---|
--goal | 目标：growth / engagement / authority |
--count | 计划篇数 |
--window | 时间范围：weekly / monthly |
流程控制
| 命令 | 作用 | 常用示例 |
|---|---|---|
fit | 判断热点适切性 | xhs-spec fit --target trend-xxx --verdict approved |
draft | 进入起草阶段 | xhs-spec draft --target quick-xxx |
review | 审核内容 | xhs-spec review --target quick-xxx |
iterate | 迭代改写 | xhs-spec iterate --target quick-xxx --round 2 |
fit
bash
xhs-spec fit --target trend-xxx --verdict approved
xhs-spec fit --target trend-xxx --verdict rejecteddraft
bash
# quick/trend
xhs-spec draft --target quick-xxx
# campaign 需要指定 note
xhs-spec draft --target campaign-xxx --note note-01iterate
bash
xhs-spec iterate --target quick-xxx --round 2发布与归档
| 命令 | 作用 | 常用示例 |
|---|---|---|
publish | 生成发布包 | xhs-spec publish --target quick-xxx --date 2026-03-13 |
archive | 归档并复盘 | xhs-spec archive --target quick-xxx --outcome completed |
publish
bash
xhs-spec publish --target quick-xxx --date 2026-03-13生成 publish/2026-03-13/quick-xxx-标题/ 目录，包含终稿、封面、素材等。
archive
bash
xhs-spec archive --target quick-xxx --outcome completed
xhs-spec archive --target trend-xxx --outcome published
xhs-spec archive --target trend-xxx --outcome droppedoutcome 取值：completed / published / dropped
archive 会生成 retrospective.md，并把结构化 lesson 写回 .xhsspec/knowledge/*.md。如果这个 run 已经生成过发布包，archive 还会自动把 publish/... 路径挂进 retrospective 和 knowledge block，方便后续续写和复盘。
查看状态
| 命令 | 作用 | 常用示例 |
|---|---|---|
status | 查看运行状态 | xhs-spec status --all / xhs-spec status --target quick-xxx |
validate | 校验配置 | xhs-spec validate --target repo |
典型工作流
bash
# 完整 quick 流程
xhs-spec init --tools claude-code
xhs-spec quick --idea "为什么团队需要repo-first内容系统"
xhs-spec review --target quick-001
xhs-spec iterate --target quick-001 --round 2
xhs-spec publish --target quick-001 --date 2026-03-13
xhs-spec archive --target quick-001 --outcome published