关于 config-reader
config-reader 用于读取 `.agents.yml` 和 `.agents.local.yml` 中的配置值。它优先采用本地覆盖项,再回退到基础文件或指定默认值,并需要 yq。
主要功能
- 01读取基础和本地 YAML 配置
- 02本地值覆盖基础值
- 03支持嵌套字段路径
- 04字段缺失时返回指定默认值
- 05需要 yq
适用场景
- 01查看项目的技术栈设置
- 02读取嵌套工作流选项
- 03获取浏览器类型设置
- 04为缺失字段使用回退值
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ majesticlabs-dev/ majestic-marketplace --skill config-reader安装后在 Claude Code 中输入/config-reader确认已加载。
附带文件scripts/config_reader.sh
详细介绍
配置读取器
读取并合并 .agents.yml 和 .agents.local.yml 配置文件。本地配置会覆盖基础配置。
要求: yq(brew install yq 或 snap install yq)
参数
$ARGUMENTS 格式:<field> [default]
示例:
auto_preview false- 获取顶层字段,默认值为 "false"plan.auto_create_task false- 获取嵌套字段,默认值为 "false"tech_stack generic- 获取顶层字段,默认值为 "generic"browser.type chrome- 获取嵌套的浏览器类型toolbox.build_task.design_system_path- 获取深层嵌套字段
执行
使用解析后的参数运行配置读取脚本:
bash {baseDir}/scripts/config_reader.sh FIELD DEFAULT
将 FIELD 和 DEFAULT 替换为从 $ARGUMENTS 解析出的参数。
返回值
仅返回配置值(单行):
truerailsgithub
合并逻辑
- 先检查本地配置 - 如果存在该键,则以
.agents.local.yml为准 - 回退到基础配置 - 如果本地配置中没有,则使用
.agents.yml - 默认值 - 如果两者都没有该键,则使用提供的默认值
常用字段
| 字段 | 描述 | 典型默认值 |
|---|---|---|
auto_preview | 自动打开 Markdown 文件 | false |
plan.auto_create_task | 根据计划自动创建任务 | false |
tech_stack | 主要技术栈 | generic |
task_management | 任务跟踪后端 | none |
workflow | Git 工作流风格 | branches |
toolbox.build_task.design_system_path | 设计系统位置 | (无) |
评论
支持 Markdown