Skip to content

Config Reference

Full reference for all fields in .bytemind/config.json.

For a working example see config.example.json.

provider

Model provider configuration.

FieldTypeDescriptionDefault
typestringopenai-compatible, anthropic, or geminiopenai-compatible
base_urlstringAPI endpoint URLhttps://api.openai.com/v1
modelstringModel ID to usegpt-5.4-mini
api_keystringAPI key (plain text - prefer api_key_env)-
api_key_envstringEnv var name to read the key fromBYTEMIND_API_KEY
anthropic_versionstringAnthropic API version header2023-06-01
auth_headerstringCustom auth header nameAuthorization
auth_schemestringAuth scheme prefix (e.g. Bearer)Bearer
auto_detect_typeboolInfer provider type from base_urlfalse

approval_policy

ValueBehavior
on-request (default)Wait for confirmation before each high-risk tool call

approval_mode

ValueBehavior
interactive (default)Prompt for approval on each operation
full_accessAuto-approve approval-required actions with no prompt

away_policy

Deprecated compatibility field. Legacy approval_mode: away is blocked by default to prevent silent privilege escalation. Temporarily set BYTEMIND_ALLOW_AWAY_FULL_ACCESS=true only when migrating old configs; away_policy remains compatibility-only.

ValueBehavior
auto_deny_continue (default)Accepted for compatibility; no runtime behavior change
fail_fastAccepted for compatibility; no runtime behavior change

notifications.desktop

Desktop notification preferences.

FieldTypeDefaultDescription
enabledbooltrueMaster switch for desktop notifications.
on_approval_requiredbooltrueNotify when an approval prompt is raised.
on_run_completedbooltrueNotify when a run completes successfully.
on_run_failedbooltrueNotify when a run fails.
on_run_canceledboolfalseNotify when a run is canceled.
cooldown_secondsint3Cooldown window for duplicate notification keys. 0 disables cooldown dedupe.

max_iterations

TypeDefault
integer32

Maximum number of tool-call rounds per task. When reached, the agent summarizes progress and stops.

stream

TypeDefault
booltrue

Enable streaming output. Set to false for non-TTY environments.

sandbox_enabled

TypeDefault
boolfalse

When true, file and shell tools are restricted to writable_roots.

writable_roots

TypeDefault
string[][]

List of directories the agent is allowed to write to when sandbox is enabled.

exec_allowlist

List of shell commands that skip the approval prompt.

json
{
  "exec_allowlist": [
    { "command": "go", "args_pattern": ["test", "./..."] },
    { "command": "make", "args_pattern": ["build"] }
  ]
}

token_quota

TypeDefault
integer300000

Warning threshold for token consumption per session.

update_check

FieldTypeDefaultDescription
enabledbooltrueEnable/disable update check on startup

context_budget

Controls context window management.

FieldTypeDefaultDescription
warning_ratiofloat0.85Emit warning at this fraction of context usage
critical_ratiofloat0.95Trigger compaction/stop at this fraction
max_reactive_retryint1Max retries after context compaction

Full Example

json
{
  "provider": {
    "type": "openai-compatible",
    "base_url": "https://api.openai.com/v1",
    "model": "gpt-4o",
    "api_key_env": "OPENAI_API_KEY"
  },
  "approval_policy": "on-request",
  "approval_mode": "interactive",
  "notifications": {
    "desktop": {
      "enabled": true,
      "on_approval_required": true,
      "on_run_completed": true,
      "on_run_failed": true,
      "on_run_canceled": false,
      "cooldown_seconds": 3
    }
  },
  "max_iterations": 32,
  "stream": true,
  "sandbox_enabled": false,
  "writable_roots": [],
  "token_quota": 300000,
  "update_check": { "enabled": true },
  "context_budget": {
    "warning_ratio": 0.85,
    "critical_ratio": 0.95,
    "max_reactive_retry": 1
  }
}

Released under the MIT License.