quickstart

引导式首次运行：确保存在配置档案，预览写入内容，然后安装。

概要Copy Anchor Link

apothem quickstart [--harness NAME|all] [--project PATH] [--profile PATH]
                   [--yes] [--quiet|-q] [--verbose|-v]
                   [--format plain|json] [--json] [--no-color]

quickstart 是面向新操作者的唯一引导式入口点。它在一条线性流程中：(1) 确保存在共享配置档案——若未找到，则创建一个起始配置档案并提醒你将其个性化；(2) 预览所选工具将要写入的具体文件，按项目根目录与你的主目录分组；(3) 请求确认；(4) 以分组、去除冗余信息的能力说明输出进行安装；(5) 打印推荐的后续命令。

它组合使用 install 命令所用的相同构件——而不重新实现它们。--project 默认为当前目录。--harness 没有默认值：省略它时，quickstart 会询问要安装哪个工具，因此首次运行写入的是一个工具的配置。--harness all 会安装每个受支持的工具，并且始终是一项显式选择。

行为Copy Anchor Link

• 工具——未提供 --harness 时，交互式运行会列出受支持的名称（外加 all），并在写入任何内容之前要求选择一个。无法询问的运行（--yes、--format json 或没有终端）会以一个指出 --harness 选项的用法错误停止，并且不写入任何内容。
• 配置档案——如果解析出的配置档案路径下没有文件，quickstart 会提议创建一个起始配置档案（在 --yes、非交互式 shell 或 --format json 下自动创建），并指出需要个性化的占位身份字段。
• 预览 + 确认——对于 --harness all，目标会按两个标题列出（项目根目录与你的主目录），交互式运行会在写入项目之外的内容之前进行确认。单个指定的工具会直接安装，不做预览或提示。--yes、非交互式 shell 和 --format json 会在不提示的情况下继续。拒绝 --harness all 的预览会在安装写入之前中止；第 1 步中创建的起始配置档案会被保留。
• 安装——工具原生不支持的能力会按工具汇总为一条分组说明（传入 --verbose 可查看逐项能力的详情）；完整列表始终位于 --format json 的 warnings 数组中。
• 下一步——终端输出会指出后续命令（apothem verify …、apothem doctor）。

选项Copy Anchor Link

JSON 输出Copy Anchor Link

--format json 会输出单个文档，汇总每个引导步骤：

{
  "schema_version": 1,
  "status": "success",
  "command": "quickstart",
  "profile_path": "C:\\Users\\Example\\.config\\apothem\\profile.yaml",
  "steps": [
    {"step": "profile", "outcome": "created", "path": "…", "placeholder_identity": ["name", "email", "github"]},
    {"step": "install", "status": "success", "harness": "all", "files_written": ["…"], "warnings": [], "results": []},
    {"step": "recommend", "next": ["apothem verify --harness all --project .", "apothem doctor"]}
  ],
  "recommended_next": ["apothem verify --harness all --project .", "apothem doctor"]
}

示例Copy Anchor Link

apothem quickstart                                  # asks which harness
apothem quickstart --harness claude-code --yes
apothem quickstart --harness all --project . --yes  # every harness, explicitly
apothem quickstart --harness claude-code --json

退出码Copy Anchor Link

另请参阅Copy Anchor Link

• apothem install——从共享配置档案物化一个工具
• apothem verify——确认安装已生效
• apothem doctor——环境与安装的健康状况
• 入门——完整安装指南