$ reference
Konfiguration
config.toml: pro Repo unter .boost/config.toml oder global unter ~/.boost/config.toml.Wo Boost die Config sucht
Boost liest die erste config.toml in dieser Reihenfolge:
.boost/config.tomlim aktuellen Verzeichnis..boost/config.tomlan der Git-Repo-Wurzel.~/.boost/config.tomlim Home — globaler Fallback vonboost init.
Legacy boost.config.toml wird noch gelesen, .boost/config.toml hat Vorrang.
Aus Monorepo-Unterordnern liest Boost <repo-root>/.boost/config.toml.
Config- vs. Datenverzeichnis
Config liegt unter .boost/. Daten — history.db, Cache, Tee-Logs — im OS-Datenverzeichnis:
- macOS — ~/Library/Application Support/boost/
- Linux — $XDG_DATA_HOME/boost/ or ~/.local/share/boost/
- Windows — %LOCALAPPDATA%\boost\
DB-Pfad mit BOOST_DB_PATH oder [tracking] database_path setzen.
Hook-Rewrite für bestimmte Befehle überspringen
Hooks umschreiben unterstützte Tools zu boost <cmd>. Einträge in [hooks] exclude_commands bleiben unverpackt.
.boost/config.toml
[hooks]
exclude_commands = ["playwright", "vim", "docker"]
Mit dem Beispiel bleibt playwright test unverändert.
Nur Hook-Rewrite
exclude_commands verhindert kein direktes boost playwright test.
Alle Einstellungen
Jeder Schlüssel ist optional; Top-Level-Keys schreibt boost init.
~/.boost/config.toml — global defaults
accept_terms = "yes"
[hooks]
exclude_commands = ["vim", "nano"]
[tracing]
report = false # silence per-command stderr savings lines
upload = false # skip remote OTLP upload (local spans still recorded)
[report]
usd_per_million_tokens = 5.0
co2e_kg_per_million_tokens = 0.21
[filters]
disabled = [] # filter names skipped by the engine; retrieve auto-appends
retrieve_disable_threshold = 3 # retrieves per capability_id before auto-disable; 0 = never
[mcp]
toon_format = false # opt in to MCP JSON→TOON (also needs Unleash boost-mcp-toon-format)
[update]
auto_update = false # only read from ~/.boost/config.toml
Projekt-.boost/config.toml setzt nur Abweichungen:
.boost/config.toml — project override
[tracking]
database_path = "/data/ci/history.db" # this repo's CI containers only
[report]
co2e_kg_per_million_tokens = 0.09 # this team's low-carbon region
Un gesetzte Keys erben vom globalen File.
| Schlüssel | Zweck | Standard |
|---|---|---|
| accept_terms | Zeichnet die Annahme der Bedingungen auf; gesetzt von boost init. | unset |
| [hooks] exclude_commands | Befehlsnamen, die der Hook überspringt (Binärname des ersten Worts). | [ ] |
| [tracing] report | false blendet stderr-Einsparung aus. BOOST_REPORT überschreibt. | true |
| [tracing] upload | false überspringt den Remote-OTLP-Upload von boost sync (gebündelter Endpoint und externer Spiegel). Spans bleiben lokal; --file-JSONL wird weiter geschrieben. | true |
| [tracking] database_path | SQLite-Historie-DB-Pfad. BOOST_DB_PATH gewinnt. | OS data dir / history.db |
| [report] usd_per_million_tokens | USD pro 1M gesparte Tokens für boost report. | 5.0 |
| [report] co2e_kg_per_million_tokens | kg CO2e vermieden pro 1M gesparte Tokens. | 0.21 |
| [filters] disabled | Übersprungene TOML-Filter. boost retrieve hängt Rollback-Namen an. | [] |
| [filters] retrieve_disable_threshold | Retrieve-Ereignisse pro capability_id bis Auto-Disable. 0 = nie. | 3 |
| [update] auto_update | false deaktiviert Hintergrund-Updates. Nur globale Config. | true |
Umgebungsvariablen
Umgebungsvariablen haben Vorrang vor config.toml.
| Variable | Wirkung |
|---|---|
| BOOST_DB_PATH | Pfad zur SQLite-DB; überschreibt [tracking] database_path. |
| BOOST_REPORT | 0 schaltet stderr-Einsparung pro Befehl aus. |
| BOOST_REPORT_USD_PER_MTOK | Überschreibt [report] usd_per_million_tokens. |
| BOOST_REPORT_CO2E_KG_PER_MTOK | Überschreibt [report] co2e_kg_per_million_tokens. |
| BOOST_TEE_DIR | Verzeichnis für Tee-Logs bei Fehlern. |
| XDG_DATA_HOME / LOCALAPPDATA | Verschiebt das Datenverzeichnis unter Linux / Windows. |
Übersicht
| Ziel | Mechanismus |
|---|---|
| Einstellungen für ein Projekt | .boost/config.toml |
| Einstellungen für alle Projekte | ~/.boost/config.toml |
Agent soll playwright, vim usw. nicht wrappen | [hooks] exclude_commands |
| Historien-Datenbank verschieben | BOOST_DB_PATH or [tracking] database_path |
| stderr-Einsparung pro Befehl ausblenden | [tracing] report = false or BOOST_REPORT=0 |
| Remote-Telemetrie-Upload deaktivieren | [tracing] upload = false |
| Hintergrund-Updates deaktivieren | [update] auto_update = false in ~/.boost/config.toml |
Weiterführend
$ BOOST_REPORT_USD_PER_MTOK=9 boost report -w # one run; config.toml unchanged
$ BOOST_DB_PATH=/tmp/ci.db boost go test ./...
$ BOOST_REPORT=0 boost npm test