English

日本語

6. Config Files

Explains Climpt’s directory structure and configuration file details.

6.1 Directory Structure

Overall Structure

your-project/
├── .agent/
│   └── climpt/
│       ├── config/                    # Config files
│       │   ├── registry_config.json   # Registry configuration
│       │   ├── default-app.yml        # Default configuration
│       │   ├── default-user.yml       # User configuration (optional)
│       │   └── {domain}-app.yml       # Per-domain configuration
│       ├── prompts/                   # Prompt templates
│       │   └── {c1}/{c2}/{c3}/f_{edition}.md
│       ├── frontmatter-to-schema/     # Generated JSON Schema (by generate-registry)
│       └── registry.json              # Command registry
├── .deno/bin/                         # CLI executables
│   ├── climpt, climpt-git, climpt-meta, climpt-code, climpt-test
└── .agent/                            # Agents (optional)
    ├── iterator/agent.json
    ├── reviewer/agent.json
    └── facilitator/agent.json

Directory Roles

Directory	Role	Required
.agent/climpt/config/	Config file storage	Yes
.agent/climpt/prompts/	Prompt templates	Yes
.agent/climpt/frontmatter-to-schema/	Generated JSON Schema	No (auto-generated)
.deno/bin/	CLI executables	Not needed for MCP only

Prompt Directory Structure

prompts/{c1}/{c2}/{c3}/f_{edition}_{adaptation}.md
         │     │    │        │          │
         │     │    │        │          └─ Processing mode (optional)
         │     │    │        └─ Edition (default if omitted)
         │     │    └─ Target (object)
         │     └─ Action (verb)
         └─ Domain (area)

---

6.2 app.yml (Application Configuration)

Defines prompt and schema placement directories for each domain.

Filename Convention

.agent/climpt/config/{domain}-app.yml

Examples: git-app.yml (for climpt-git), code-app.yml (for climpt-code), default-app.yml (when --config not specified).

Configuration Items

# .agent/climpt/config/git-app.yml

# Working directory (base for prompt search)
working_dir: ".agent/climpt"

# Prompt file location
app_prompt:
  base_dir: "prompts/git" # Relative path from working_dir

# Schema file location (optional)
app_schema:
  base_dir: "schema/git"

Configuration Item Descriptions

Item	Description	Required
working_dir	Base directory for prompt search	Yes
app_prompt.base_dir	Base directory for prompt files	Yes
app_schema.base_dir	Base directory for schema files	No

Path Resolution Mechanism

How the command resolves to prompt file path:

Command: climpt-git decide-branch working-branch

1. working_dir: ".agent/climpt"
2. app_prompt.base_dir: "prompts/git"
3. c2: "decide-branch"
4. c3: "working-branch"
5. filename: "f_default.md"

Result: .agent/climpt/prompts/git/decide-branch/working-branch/f_default.md

---

6.3 user.yml (User Configuration)

Customize option default values and behavior.

Filename Convention

.agent/climpt/config/{domain}-user.yml

Configuration Items

# .agent/climpt/config/git-user.yml

# Output destination prefix setting
options:
  destination:
    prefix: "output/git" # Prepended to paths specified with -o

# Parameter validation patterns (optional)
params:
  two:
    directiveType:
      pattern: "^(decide-branch|group-commit|merge-up)$"
    layerType:
      pattern: "^(working-branch|unstaged-changes|base-branch)$"

Configuration Item Descriptions

Item	Description
options.destination.prefix	Prefix prepended to output destination paths
params.two.directiveType.pattern	Regex validation for c2 (action)
params.two.layerType.pattern	Regex validation for c3 (target)

Destination Prefix Behavior

# When prefix: "output/git" is set in user.yml

climpt-git create issue -o=tasks/task1.md
# Actual output destination: output/git/tasks/task1.md

# Without prefix configured
# Actual output destination: tasks/task1.md

---

6.4 registry_config.json (Registry Configuration)

Manage registries for multiple agents.

File Location

Priority order (searched top to bottom):

1. .agent/climpt/config/registry_config.json (project)
2. ~/.agent/climpt/config/registry_config.json (home)
3. Default configuration (auto-generated)

Configuration Example

{
  "registries": {
    "climpt": ".agent/climpt/registry.json",
    "inspector": ".agent/inspector/registry.json",
    "auditor": ".agent/auditor/registry.json"
  }
}

Using Multiple Agents

# Search commands from different agents via MCP
search({ query: "commit", agent: "climpt" })
search({ query: "analyze", agent: "inspector" })

---

6.5 Configuration Priority

Loading Order

1. Command-line options (highest priority)
   ↓
2. user.yml settings
   ↓
3. app.yml settings
   ↓
4. Default values

Priority Example

# Command-line: -o=./custom/output
# user.yml: destination.prefix = "output/git"
# app.yml: (none)

# Result: ./custom/output (command-line takes priority)

Config File Search Order

1. .agent/climpt/config/{domain}-app.yml
2. .agent/climpt/config/default-app.yml
3. Error (config file not found)

---

Setting Up a New Domain

Step 1: Create config files

# app.yml (required)
cat > .agent/climpt/config/myapp-app.yml << 'EOF'
working_dir: ".agent/climpt"
app_prompt:
  base_dir: "prompts/myapp"
app_schema:
  base_dir: "schema/myapp"
EOF

# user.yml (optional)
cat > .agent/climpt/config/myapp-user.yml << 'EOF'
options:
  destination:
    prefix: "output/myapp"
params:
  two:
    directiveType:
      pattern: "^(create|update|delete)$"
    layerType:
      pattern: "^(item|list|detail)$"
EOF

Step 2: Create prompt directory and CLI executable

mkdir -p .agent/climpt/prompts/myapp/create/item

cat > .deno/bin/climpt-myapp << 'EOF'
#!/bin/sh
case "$1" in
    -h|--help|-v|--version)
        exec deno run --allow-read --allow-write --allow-env --allow-run --allow-net --no-config 'jsr:@aidevtool/climpt' "$@"
        ;;
    *)
        exec deno run --allow-read --allow-write --allow-env --allow-run --allow-net --no-config 'jsr:@aidevtool/climpt' --config=myapp "$@"
        ;;
esac
EOF

chmod +x .deno/bin/climpt-myapp