About config-reader
config-reader is a skill that retrieves values from `.agents.yml` and `.agents.local.yml`. It checks local overrides first, falls back to the base file, then uses an optional default; it requires yq.
Key features
- 01Reads base and local YAML config
- 02Local values override base values
- 03Supports nested field paths
- 04Returns a provided default when absent
- 05Requires yq
Use cases
- 01Checking a project's tech stack setting
- 02Reading nested workflow options
- 03Retrieving a browser type setting
- 04Using a fallback for missing fields
Install
Copy the command and run it in a terminal.
$
npx skills add https:/After installing, type/config-readerin Claude Code to confirm it loaded.
Bundled filesscripts/config_reader.sh
Details
From the project READMEConfig 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)
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 typetoolbox.build_task.design_system_path- get deeply nested field
Execution
Run the config reader script with parsed arguments:
bash {baseDir}/scripts/config_reader.sh FIELD DEFAULT
Replace FIELD and DEFAULT with the parsed arguments from $ARGUMENTS.
Return Value
Return ONLY the config value (single line):
truerailsgithub
Merge Logic
- Local checked first -
.agents.local.ymlwins if key exists - Fall back to base -
.agents.ymlif not in local - Default - provided default if neither has the key
Common Fields
| Field | Description | Typical 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) |
Comments
Markdown supported