Files
cleveragents-core/docs/reference/config_resolution.md
T
freemo 7c4663b8ee
CI / benchmark-publish (pull_request) Has been skipped
CI / lint (pull_request) Successful in 15s
CI / quality (pull_request) Successful in 18s
CI / build (pull_request) Successful in 19s
CI / typecheck (pull_request) Successful in 38s
CI / security (pull_request) Successful in 46s
CI / integration_tests (pull_request) Successful in 2m52s
CI / unit_tests (pull_request) Successful in 12m35s
CI / docker (pull_request) Successful in 38s
CI / benchmark-regression (pull_request) Successful in 20m57s
CI / coverage (pull_request) Successful in 47m23s
CI / lint (push) Successful in 12s
CI / build (push) Successful in 14s
CI / quality (push) Successful in 17s
CI / typecheck (push) Successful in 32s
CI / benchmark-regression (push) Has been skipped
CI / security (push) Successful in 40s
CI / integration_tests (push) Successful in 2m52s
CI / benchmark-publish (push) Successful in 12m29s
CI / unit_tests (push) Successful in 12m31s
CI / docker (push) Successful in 38s
CI / coverage (push) Successful in 47m17s
feat(config): add config service with multi-level resolution
Implement the complete configuration system with multi-level resolution
chain, typed key registry, and CLI integration per specification.

ConfigService changes:
- Expand _build_catalog() to register all 102 spec-aligned config keys
  across 8 groups: core (14), server (4), actor (5), plan (8),
  sandbox (5), index (12), context (43), provider (11)
- Each key carries exact dotted-dash name, Python type, default value,
  explicit env var name per spec, project-scopability flag, and
  description
- Fix _env_name() to convert dots and dashes to underscores
- Provider keys use standard env var names (e.g., OPENAI_API_KEY)

CLI commands rewiring:
- Rewrite config set/get/list to use ConfigService instead of Settings
- Add --verbose flag to config get showing full 5-level resolution chain
- Add --project flag to config set/get/list for project-scoped overrides
- Support both glob and regex patterns in config list
- Validate keys against ConfigService registry with actionable errors
- Retain backward-compatible helper functions delegating to ConfigService

Documentation:
- Add docs/reference/config_resolution.md covering resolution chain,
  all 102 config keys, CLI commands, TOML format, and provider credentials

Testing:
- Update all 4 Behave feature files and step definitions to use new
  spec-aligned key names, env vars, and defaults (119 scenarios passing)
- Add robot/config_resolution.robot with 10 integration test cases
- Add benchmarks/config_resolution_bench.py with 8 time + 2 memory suites

ISSUES CLOSED: #258
2026-03-01 04:38:30 +00:00

6.1 KiB

Configuration Resolution

CleverAgents resolves every configuration value through a 5-level precedence chain. The first level that supplies a non-None value wins.

Resolution Order

Priority Source Example
1 (highest) CLI flag --format json, --data-dir /tmp
2 Environment variable CLEVERAGENTS_CORE_LOG_LEVEL=WARNING
3 Project-scoped config [project."myapp"] table in TOML
4 Global config file ~/.cleveragents/config.toml
5 (lowest) Built-in default Hardcoded in key registry
$ export CLEVERAGENTS_CORE_LOG_LEVEL=WARNING
$ agents config set core.log_level DEBUG      # writes to global config
$ agents config get core.log_level
# -> WARNING  (env var at priority 2 beats global config at priority 4)

Key Format

Keys use hierarchical dot-separated names. The segment before the first dot is the group; everything after it is the key name within that group.

core.log.level
plan.budget.per-plan
provider.openai.api-key

Environment variable mapping follows the pattern CLEVERAGENTS_<GROUP>_<KEY> with dots and hyphens replaced by underscores and all characters uppercased:

  • core.log.levelCLEVERAGENTS_CORE_LOG_LEVEL
  • plan.budget.per-planCLEVERAGENTS_PLAN_BUDGET_PER_PLAN

Exception: provider.* credential keys use standard provider env vars (see Provider Credentials).

Configuration Groups

Group Keys Scope Description
core.* 14 Mixed Core system settings — logging, data dirs, database, runtime env
server.* 4 Global only Server mode — bind host, port, TLS, workers
actor.* 5 Mixed Actor defaults — timeout, retry, concurrency
plan.* 8 Mixed Plan execution — budget, retries, auto-apply, timeout
sandbox.* 5 Mixed Sandbox and checkpointing — strategy, cleanup, max age
index.* 12 Mixed Code intelligence and indexing — backend, embedding model, dimensions
context.* 43 All project-scopable Context tier defaults — token limits, file caps, inclusion rules
provider.* 11 Global only LLM provider credentials and model defaults
skills.* 1 Project-scopable Agent Skills discovery paths

Total: 103 registered keys.

Project-Scopable Keys

Keys marked as project-scopable can be overridden per-project in the [project."<name>"] TOML table. When a project name is active, the resolver checks this table at priority 3 before falling back to the global value.

Fully project-scopable groups:

  • context.* — all 43 keys

Partially project-scopable groups:

  • core.*log.level, debug.enabled, env, data-dir
  • actor.*timeout, max-retries, concurrency
  • plan.*auto-apply, max-retries, timeout, budget.per-plan
  • sandbox.*strategy, auto-cleanup, max-age-hours
  • index.*enabled, backend, embedding-model, embedding-dimension

Never project-scopable:

  • server.* — applies globally to the running process
  • provider.* — credentials are always global

CLI Commands

agents config set

agents config set <key> <value> [--project <name>]

Writes a value to the global config file (or to the project-scoped table when --project is supplied). The value is coerced to the key's registered type.

agents config get

agents config get <key> [--verbose] [--project <name>]
Flag Effect
--verbose Print the full resolution chain showing every level
--project Resolve as if inside the named project

Verbose output example:

$ agents config get core.log.level --verbose
Key:    core.log.level
Value:  INFO
Source: default

Resolution chain (highest → lowest):
  cli_flag       → (not set)
  env_var        → (not set)  [CLEVERAGENTS_CORE_LOG_LEVEL]
  project        → (not set)
  global         → (not set)  [~/.cleveragents/config.toml]
  default        → INFO       ← active

agents config list

agents config list [pattern] [--filter-values] [--show-secrets] [--project <name>]
Flag Effect
pattern Glob filter on key names (e.g. core.*, plan.budget.*)
--filter-values Only show keys whose resolved value differs from the default
--show-secrets Unmask secret values (provider keys are masked by default)
--project Resolve values in the context of the named project

TOML File Format

~/.cleveragents/config.toml:

[core]
log_level = "DEBUG"
data_dir  = "/var/lib/cleveragents"

[plan]
auto_apply  = true
max_retries = 5

[sandbox]
strategy = "container"

[index]
enabled         = true
backend         = "faiss"
embedding_model = "text-embedding-3-small"

# Project-scoped overrides
[project."myapp"]
core.log_level     = "WARNING"
plan.auto_apply    = false
context.max_tokens = 64000

[project."data-pipeline"]
plan.budget.per_plan = 2.50
sandbox.strategy     = "git_worktree"

Parent directories are created automatically on the first write.

Provider Credentials

Provider keys use standard provider environment variable names, not the CLEVERAGENTS_* convention. This avoids requiring users to duplicate credentials under a project-specific prefix.

Key Environment Variable
provider.openai.api-key OPENAI_API_KEY
provider.anthropic.api-key ANTHROPIC_API_KEY
provider.google.api-key GOOGLE_API_KEY
provider.azure.api-key AZURE_OPENAI_API_KEY
provider.default-provider CLEVERAGENTS_PROVIDER_DEFAULT_PROVIDER
provider.default-model CLEVERAGENTS_PROVIDER_DEFAULT_MODEL
provider.temperature CLEVERAGENTS_PROVIDER_TEMPERATURE

Provider credential values are masked in config list output by default. Use --show-secrets to reveal them.

Validation

  • Unknown keys produce an actionable error listing valid keys.
  • Type mismatches raise TypeError with the expected type and actual value.
  • Boolean coercion accepts true/false, 1/0, yes/no (case-insensitive).