Skip to content
Apothem
操作指南

编辑配置文件

更改共享配置档案并为每个已安装的工具重新物化。

目标:更改共享配置档案中的某个值,并将其推送到你已安装的每个工具。

前置条件

  • apothem CLI 在你的 PATH 上(或采用自包含形式:加前缀 PYTHONPATH="$HOME/.apothem/src" 并运行 python -m apothem,或使用 npx @ahmed-g-gad/apothem)。
  • 位于 ~/.config/apothem/profile.yaml 的配置文件。若缺失,可用 apothem profile init 创建一份。

配置文件结构

配置文件是单个 YAML 文档。其顶层键为:

  • identity(必填)—— name,加上可选的 role、email、website、 github。
  • preferences —— language、style(concise / verbose / balanced)、 formatter、test_framework。
  • rules —— 与有能力的工具共享的额外规则字符串列表。
  • seriousness —— EXPLORING、PERSONAL_USE、SHARED、 PUBLIC_LAUNCH 之一。
  • enforcement —— 选择性启用的开关(sprints、agent_teams、multitasking、 continuous_execution、learning_loop),每个标志默认关闭。
  • harnesses —— 以工具 id 为键的各工具覆盖项。
  • exclude_harnesses —— 被批量命令(--harness all)跳过的工具 id。
  • mcp_servers —— 以服务器名称为键的 MCP 服务器定义。
  • agent_mcp_servers —— 按辅助器名称列出该辅助器可以调用的 MCP 服务器 (参见让辅助器访问 MCP 服务器)。 默认为空,因此没有任何辅助器能触及 MCP 工具。
  • workspace —— Apothem 存放其共享工作目录的位置 (directory_name、scope)。
  • schema_version —— 可选的配置档案 schema 版本;不含该字段的配置档案按 版本 1 读取。

每个字段都列在配置档案字段中。

步骤

  1. 检查当前配置文件:

    apothem profile show
  2. 编辑它。在系统编辑器中打开:

    apothem profile edit

    或从命令行设置单个点分键。该值按字面存储(true/false 以及显式的 [..]/{..} 输入除外,这些会被解析),并在写入前根据模式进行验证 —— 无效的设置会被 拒绝,磁盘上的配置文件保持不变:

    apothem profile set seriousness SHARED
    apothem profile set identity.name "Ada Lovelace"
  3. 重新物化各工具,使更改到达它们的原生配置。对于用户作用域的工具:

    apothem update --harness claude-code

    对于项目作用域的工具,传入项目根目录;用 all 刷新每个已安装的工具:

    apothem update --harness cursor --project /path/to/project
    apothem update --harness all --project /path/to/project

验证

apothem profile show
apothem verify --harness all

profile show 会反映你的编辑。

apothem verify --harness all 会检查每个已注册的工具,但不包括共享配置档案中 exclude_harnesses 列出的工具,因此除非其余工具全部已安装,否则它会以非零状态退出。项目作用域的工具还需要 --project PATH;若未提供,批量检查会以 project.required 错误停止。若只检查你更新过的工具,请使用同一命令并指定该工具的名称:

apothem verify --harness <name>

若要获得容忍未安装工具的整机视图,请运行 apothem doctor。

相关

  • 添加工具,以在重新物化之前将一个新工具 纳入配置文件的管理。
  • 更新 涵盖在重新物化步骤的同时升级引擎。

On this page