Skip to content

Configuration

Read from, in ascending precedence — the last one that names a setting wins:

  • <config directory>/mbx/config.toml (global), toml

bypass_log

  • Type: option<path>
  • Optional: true
  • Scope: only from the environment or the command line
  • Set with: MBX_BYPASS_LOG

Append the full reason for every bypassed compilation to this path.

cache_dir

  • Type: option<path>
  • Optional: true
  • Default: platform cache directory
  • Set with: MBX_CACHE_DIR

Cache root.

gc.auto

  • Type: bool
  • Default: true
  • Set with: MBX_GC_AUTO

Sweep after a build when collection is due.

gc.interval

  • Type: duration
  • Default: 1h
  • Set with: MBX_GC_INTERVAL

Minimum interval between automatic sweeps.

gc.max_size

  • Type: option<string>
  • Optional: true
  • Default: 5% of the cache disk, from 5GiB to 100GiB
  • Set with: MBX_GC_MAX_SIZE

Action-store budget.

gc.max_total_size

  • Type: option<string>
  • Optional: true
  • Set with: MBX_GC_MAX_TOTAL_SIZE

Combined action-store and managed-target budget, or "none".

http.download_timeout

  • Type: duration
  • Default: 10m
  • Set with: MBX_HTTP_DOWNLOAD_TIMEOUT

Blob download timeout.

http.retries

  • Type: int
  • Default: 3
  • Set with: MBX_HTTP_RETRIES

Request retries.

http.timeout

  • Type: duration
  • Default: 30s
  • Set with: MBX_HTTP_TIMEOUT

Connect and request timeout.

incremental

  • Type: bool
  • Default: false
  • Set with: MBX_INCREMENTAL

Let local workspace members compile incrementally.

remote.mode

  • Type: string
  • Default: read-write
  • Set with: MBX_REMOTE_MODE

Remote access mode.

Choices:

  • read-write
  • read-only
  • write-only

remote.namespace

  • Type: option<string>
  • Optional: true
  • Set with: MBX_REMOTE_NAMESPACE

Remote namespace; required when a URL is configured.

remote.oidc_audience

  • Type: option<string>
  • Optional: true
  • Set with: MBX_REMOTE_OIDC_AUDIENCE

CI OIDC audience.

remote.token

  • Type: option<string>
  • Optional: true
  • Set with: MBX_REMOTE_TOKEN

Bearer token for the remote cache.

remote.token_file

  • Type: option<path>
  • Optional: true
  • Set with: MBX_REMOTE_TOKEN_FILE

File containing a bearer token.

remote.url

  • Type: option<url>
  • Optional: true
  • Set with: MBX_REMOTE_URL

Remote cache URL.

share_out_dir

  • Type: bool
  • Default: false
  • Set with: MBX_SHARE_OUT_DIR

Share eligible compilations that read OUT_DIR.

stats_report

  • Type: option<path>
  • Optional: true
  • Set with: MBX_STATS_REPORT

Write a JSON build report to this path.

target.max_age

  • Type: duration
  • Default: 30d
  • Set with: MBX_TARGET_MAX_AGE

Collect live managed targets unused this long, or "none".

target.max_size

  • Type: option<string>
  • Optional: true
  • Default: 10% of the cache disk, from 10GiB to 100GiB
  • Set with: MBX_TARGET_MAX_SIZE

Managed-target budget, or "none". Live views are collected oldest-first.

target.root

  • Type: option<path>
  • Optional: true
  • Default: <cache_dir>/targets
  • Set with: MBX_TARGET_ROOT

Managed target root.

target.views

  • Type: bool
  • Default: true
  • Set with: MBX_TARGET_VIEWS

Let mbx place eligible target directories under the managed root.

verify

  • Type: bool
  • Default: false
  • Scope: only from the environment or the command line
  • Set with: MBX_VERIFY

Compile and consult the cache, then compare outputs.

MIT LicenseCopyright © 2026jdx.dev