Skip to main content

Configuration

Caveman has two configuration layers:

  1. feature configuration used by caveman wrap and agent shortcuts;
  2. proxy configuration used by caveman start.

Credentials belong in environment variables or provider-native credential stores. Do not put API keys in either configuration file.

Feature configuration​

Global feature configuration lives at:

~/.caveman-cloud/config.json

A project can add a restricted overlay at:

./.caveman/config.json

Inspect the resolved path and values with:

caveman tools config path
caveman tools config get think.mode

Keys and defaults​

KeyDefaultAccepted valuesMeaning
think.modecompresscompress, record, pixelMain request mode
think.coretrueBooleanEnable core context compression
think.toontrueBooleanAllow TOON when it is smaller and supported
think.shrinktrueBooleanEnable output shrinking where supported
think.pixel.models[]Model-name arrayModels allowed to receive pixel context
think.pixel.densitybalancedconservative, balanced, maxPixel packing density
remember.memtrueBooleanEnable local memory integration
remember.offloadautoauto, on, offControl automatic memory offload
remember.recallfalseBooleanEnable automatic memory recall
execute.mcpautoauto, marker-only, true, falseControl MCP recovery server wiring
execute.browse_tooltrueBooleanExpose browser tool integration
execute.browse_clifalseBooleanEnable browser command integration
execute.delegatefalseBooleanEnable supported delegation integration
execute.proxytrueBooleanRoute supported agents through local proxy

Project overlays may set think.toon, think.shrink, remember.*, and execute.*. They cannot change think.mode, think.core, or pixel settings. This prevents a checked-in project file from silently enabling a more invasive transformation mode.

Environment overrides​

Environment variables take precedence over stored feature configuration.

VariableCorresponding setting
CAVEMAN_WRAP_MODEthink.mode
CAVEMAN_COREthink.core
CAVEMAN_TOONthink.toon
CAVEMAN_SHRINKthink.shrink
CAVEMAN_MCPexecute.mcp
CAVE_PIXEL_MODELSthink.pixel.models
CAVE_PIXEL_DENSITYthink.pixel.density

Use environment overrides for temporary sessions. Use caveman tools config set for durable operator choices.

Proxy configuration​

Default proxy configuration path:

~/.caveman/caveman.yaml

Set CAVEMAN_CONFIG to load another file.

label: local
mode: record
listen: 127.0.0.1:8787
optimizers: []
subscription_compress: false
toolschema_strip: false
providers: {}
compat: {}

Main fields​

FieldMeaning
labelHuman-readable installation label
modeProxy operating mode
listenLocal listen address
optimizersExplicit optimizer configuration
subscription_compressAllow eligible subscription traffic compression
toolschema_stripAllow configured tool-schema annotation stripping
breakpoint_planOptional cache breakpoint plan
providersProvider endpoint, billing tier and region overrides
compatNamed OpenAI-compatible provider mounts

Accepted internal proxy modes are record, recommend, shadow, canary, active, compress, and pixel. Unknown values resolve to record. Operator-facing local workflows normally use record, compress, or pixel.

CAVEMAN_MODE can override proxy YAML mode for caveman start.

Provider overrides​

Provider entries can change public endpoint or regional information without putting secrets in YAML.

providers:
bedrock:
region: eu-west-1
azure:
base_url: https://example-resource.openai.azure.com

compat:
local-model:
base_url: http://127.0.0.1:11434/v1
api_key_env: LOCAL_MODEL_API_KEY

Self-hosted private or loopback upstreams require an explicit CAVE_SSRF_ALLOWLIST entry. See Security and privacy.

Provider credentials​

The proxy preserves an inbound request credential. When an integration does not send one, supported providers can use their standard environment variables. Common examples include:

ANTHROPIC_API_KEY
OPENAI_API_KEY
GEMINI_API_KEY
AZURE_OPENAI_API_KEY

Amazon Bedrock supports its native authentication paths, including AWS credentials and supported bearer-token configuration. Prefer provider-native credential discovery over copying secrets into shell history.

Precedence summary​

Feature configuration resolves from defaults, global file, allowed project overlay, then environment override. Proxy mode resolves from default, YAML, then CAVEMAN_MODE. Command flags can select an explicit session mode such as caveman wrap --off or --pixel.

When resolution fails or a mode is unknown, request transformation fails safe: the runtime uses record or original-byte behavior instead of guessing.