Skip to content

Configuration

Botholomew reads its settings from .botholomew/config.json. The full schema lives in src/config/schemas.ts.

json
{
  "anthropic_api_key": "",
  "model": "claude-opus-4-6",
  "chunker_model": "claude-haiku-4-5-20251001",
  "embedding_model": "Xenova/bge-small-en-v1.5",
  "embedding_dimension": 384,
  "tick_interval_seconds": 300,
  "max_tick_duration_seconds": 120,
  "system_prompt_override": "",
  "max_turns": 0,
  "worker_heartbeat_interval_seconds": 15,
  "worker_dead_after_seconds": 60,
  "worker_reap_interval_seconds": 30,
  "worker_stopped_retention_seconds": 3600,
  "schedule_min_interval_seconds": 60,
  "schedule_claim_stale_seconds": 300,
  "log_level": ""
}

Keys

KeyDefaultPurpose
anthropic_api_key""Anthropic key. ANTHROPIC_API_KEY env var overrides.
modelclaude-opus-4-6Claude model for the main agent loop (workers + chat).
chunker_modelclaude-haiku-4-5-20251001Smaller/cheaper model used to propose chunk boundaries during ingestion and evaluate schedules.
embedding_modelXenova/bge-small-en-v1.5A local @huggingface/transformers feature-extraction model. Weights are downloaded on first use and cached under .botholomew/models/. Any feature-extraction model in the Xenova/* namespace works — e.g. Xenova/multilingual-e5-small (also 384-dim) for non-English content.
embedding_dimension384Vector dimension. Must match the model. Changing model + dimension requires running botholomew context reembed to recompute every stored vector — old and new vectors aren't comparable.
tick_interval_seconds300Seconds a --persist worker sleeps between ticks when there's no work. It ticks back-to-back while a backlog exists.
max_tick_duration_seconds120Soft cap per tick. Stale-task reset fires at this value.
system_prompt_override""Appended to the built-in system prompt. Use this for project-specific instructions that should be always-loaded without editing soul.md.
max_turns0Maximum tool-use turns per agent loop (0 = unlimited). Safety net against runaway loops.
worker_heartbeat_interval_seconds15How often a running worker writes to workers.last_heartbeat_at. Runs on its own setInterval, independent of the tick loop, so long LLM calls don't starve the heartbeat.
worker_dead_after_seconds60A worker whose heartbeat is older than this is considered dead. The reaper flips its status to dead and releases every task/schedule claim it held.
worker_reap_interval_seconds30How often a --persist worker scans for dead peers to reap and prunes old cleanly-stopped workers. One-shot workers don't run the reaper.
worker_stopped_retention_seconds3600Cleanly-stopped workers older than this are deleted from the workers table. Dead workers are kept as forensic evidence and not auto-pruned.
schedule_min_interval_seconds60Minimum gap between successive evaluations of the same schedule. A schedule that ran less than this many seconds ago is skipped.
schedule_claim_stale_seconds300If a worker claimed a schedule but never released it (crash), another worker may steal the claim after this many seconds.
log_level""Verbosity for botholomew CLI logs. One of silent, error, warn, info, debug. Empty string falls back to the runtime default (info normally, error under NODE_ENV=test). BOTHOLOMEW_LOG_LEVEL env var overrides this.

Environment variables

VarEffect
ANTHROPIC_API_KEYOverrides anthropic_api_key in config.
BOTHOLOMEW_LOG_LEVELOverrides log_level in config. One of silent, error, warn, info, debug.
BOTHOLOMEW_NO_UPDATE_CHECKDisable the background "new version available" check.

Tuning guidance

For personal/low-volume use: defaults are fine. One tick every five minutes is plenty when tasks are mostly "every morning, summarize my email".

For bursty workloads: lower tick_interval_seconds to 30–60. A persist worker only sleeps when the queue is empty, so this is safe — it just reduces latency between the last item landing and the next tick firing. Alternatively, spawn more one-shot workers (via cron or chat) and leave the interval alone.

For multi-worker setups: if you routinely run more than a handful of workers, consider lowering worker_reap_interval_seconds (so dead ones are cleaned quickly) and raising worker_dead_after_seconds (so a temporary DB-lock hiccup doesn't flip a live worker to dead). The defaults (30s reap, 60s threshold) are conservative.

For model-cost sensitivity:

  • Switch model to claude-sonnet-4-* or claude-haiku-*. Opus is the default because quality on complex knowledge work matters more than per-token cost for most users, but Sonnet handles the majority of tasks well.
  • The chunker_model is already Haiku — leave it there.
  • Lower max_turns (e.g., 15) to hard-cap tool-use budgets.

For prompt-sensitive workflows: use system_prompt_override to add instructions without touching soul.md. This keeps the default personality intact while layering on project-specific rules ("always respond in British English", "never call mcp_exec on the slack server without confirmation", …).


Per-project vs. global

There is no global config — everything is per-project. This is deliberate: different projects have different goals, different MCP servers, different beliefs. One Botholomew project's config shouldn't leak into another's.

Released under the MIT License.