$ reference
Configuration
config.toml : par dépôt dans .boost/config.toml, ou globalement dans ~/.boost/config.toml.Où Boost cherche la config
Boost lit le premier config.toml trouvé, dans cet ordre :
.boost/config.tomldans le répertoire courant..boost/config.tomlà la racine git du dépôt.~/.boost/config.tomldans votre home — repli global écrit parboost init.
Un ancien boost.config.toml reste lu, mais .boost/config.toml prime.
Depuis un sous-dossier de monorepo, Boost lit <repo-root>/.boost/config.toml.
Répertoire config vs. données
La config vit sous .boost/. Les données runtime — history.db, cache et tee logs — vivent dans le répertoire de données OS :
- macOS — ~/Library/Application Support/boost/
- Linux — $XDG_DATA_HOME/boost/ or ~/.local/share/boost/
- Windows — %LOCALAPPDATA%\boost\
Déplacez la base avec BOOST_DB_PATH ou [tracking] database_path.
Ignorer la réécriture de hook pour certains commandes
Les hooks Boost réécrivent les outils pris en charge en boost <cmd>. Ajoutez des noms à [hooks] exclude_commands pour les laisser nus.
.boost/config.toml
[hooks]
exclude_commands = ["playwright", "vim", "docker"]
Avec l'exemple, playwright test reste inchangé.
Réécriture de hook uniquement
exclude_commands n'empêche pas la capture si on lance boost playwright test directement.
Tous les réglages
Chaque clé est optionnelle ; boost init écrit les clés de premier niveau.
~/.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
Le .boost/config.toml du projet ne définit que les différences :
.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
Ici, les clés non définies héritent du global.
| Clé | Rôle | Défaut |
|---|---|---|
| accept_terms | Enregistre l'acceptation des conditions ; défini par boost init. | unset |
| [hooks] exclude_commands | Noms de commandes ignorés par le hook (nom binaire du premier mot). | [ ] |
| [tracing] report | Mettez false pour masquer l'économie stderr. BOOST_REPORT prime. | true |
| [tracing] upload | Mettez false pour ignorer l'upload OTLP distant de boost sync (endpoint intégré et miroir externe). Les spans restent locaux ; le JSONL --file est toujours écrit. | true |
| [tracking] database_path | Emplacement de la base SQLite. BOOST_DB_PATH gagne. | OS data dir / history.db |
| [report] usd_per_million_tokens | USD par 1M tokens économisés pour boost report. | 5.0 |
| [report] co2e_kg_per_million_tokens | kg CO2e évités par 1M tokens économisés. | 0.21 |
| [filters] disabled | Filtres TOML ignorés. boost retrieve ajoute les noms rollback après le seuil. | [] |
| [filters] retrieve_disable_threshold | Nombre de retrieve par capability_id avant auto-désactivation. 0 = jamais. | 3 |
| [update] auto_update | Mettez false pour refuser les mises à jour auto. Config globale uniquement. | true |
Variables d'environnement
Les variables d'environnement priment sur config.toml.
| Variable | Effet |
|---|---|
| BOOST_DB_PATH | Chemin de la base SQLite ; prime sur [tracking] database_path. |
| BOOST_REPORT | 0 masque l'économie stderr par commande. |
| BOOST_REPORT_USD_PER_MTOK | Remplace [report] usd_per_million_tokens. |
| BOOST_REPORT_CO2E_KG_PER_MTOK | Remplace [report] co2e_kg_per_million_tokens. |
| BOOST_TEE_DIR | Répertoire des tee logs en cas d'échec. |
| XDG_DATA_HOME / LOCALAPPDATA | Déplace le répertoire de données sur Linux / Windows. |
Résumé
| Objectif | Mécanisme |
|---|---|
| Modifier les réglages d'un projet | .boost/config.toml |
| Modifier les réglages pour tous les projets | ~/.boost/config.toml |
L'agent ne doit pas envelopper playwright, vim, etc. | [hooks] exclude_commands |
| Déplacer la base d'historique | BOOST_DB_PATH or [tracking] database_path |
| Masquer l'économie stderr par commande | [tracing] report = false or BOOST_REPORT=0 |
| Désactiver l'upload de télémétrie distant | [tracing] upload = false |
| Refuser les mises à jour en arrière-plan | [update] auto_update = false in ~/.boost/config.toml |
Voir aussi
$ 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