config-reader

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Config Reader

配置读取器

Read and merge
.agents.yml
and
.agents.local.yml
configuration files. Local config overrides base config.
Requires: yq (
brew install yq
or
snap install yq
)
读取并合并
.agents.yml
.agents.local.yml
配置文件。本地配置会覆盖基础配置。
依赖: yq(
brew install yq
snap install yq

Arguments

参数

$ARGUMENTS
format:
<field> [default]
Examples:
  • auto_preview false
    - get top-level field, default to "false"
  • plan.auto_create_task false
    - get nested field, default to "false"
  • tech_stack generic
    - get top-level field, default to "generic"
  • browser.type chrome
    - get nested browser type
  • toolbox.build_task.design_system_path
    - get deeply nested field
$ARGUMENTS
格式:
<字段> [默认值]
示例:
  • auto_preview false
    - 获取顶级字段,默认值为“false”
  • plan.auto_create_task false
    - 获取嵌套字段,默认值为“false”
  • tech_stack generic
    - 获取顶级字段,默认值为“generic”
  • browser.type chrome
    - 获取嵌套的浏览器类型字段
  • toolbox.build_task.design_system_path
    - 获取深层嵌套字段

Execution

执行方式

Run the config reader script with parsed arguments:
bash
bash {baseDir}/scripts/config_reader.sh FIELD DEFAULT
Replace
FIELD
and
DEFAULT
with the parsed arguments from
$ARGUMENTS
.
使用解析后的参数运行配置读取器脚本:
bash
bash {baseDir}/scripts/config_reader.sh FIELD DEFAULT
FIELD
DEFAULT
替换为从
$ARGUMENTS
解析得到的参数。

Return Value

返回值

Return ONLY the config value (single line):
  • true
  • rails
  • github
仅返回配置值(单行):
  • true
  • rails
  • github

Merge Logic

合并逻辑

  1. Local checked first -
    .agents.local.yml
    wins if key exists
  2. Fall back to base -
    .agents.yml
    if not in local
  3. Default - provided default if neither has the key
  1. 优先检查本地配置 - 如果键存在,
    .agents.local.yml
    的配置生效
  2. 回退到基础配置 - 如果本地配置中没有该键,则使用
    .agents.yml
    的配置
  3. 默认值 - 如果两个配置文件都没有该键,则使用提供的默认值

Common Fields

常见字段

FieldDescriptionTypical Default
auto_preview
Auto-open markdown files
false
plan.auto_create_task
Auto-create tasks from plans
false
tech_stack
Primary tech stack
generic
task_management
Task tracking backend
none
workflow
Git workflow style
branches
toolbox.build_task.design_system_path
Design system location(none)
字段描述典型默认值
auto_preview
自动打开Markdown文件
false
plan.auto_create_task
从计划自动创建任务
false
tech_stack
主要技术栈
generic
task_management
任务跟踪后端
none
workflow
Git工作流风格
branches
toolbox.build_task.design_system_path
设计系统位置(无)