Configuration

Configuration

Beez settings are Lua tables. You can split them between a global user file, a project file, environment variables, and CLI flags. Only set what you need; everything else keeps its default.

Contents

• Configuration Overview - how layers merge and how to inspect the result
• Global User Config - ~/.config/beez/config.lua
• Project Config - beez.config() and config.lua
• Environment Variables - .env, env.vars, cache fingerprints, secrets
• Performance Settings - threads, cache writes, hashing
• Cache Settings - path, hash, compression
• UI and Output - output modes, themes, progress, summaries, logs
• Config Reference - all keys at a glance

Quick commands

beez --show-config # print merged active settings
beez --config-options # list top-level config keys
beez --config-options cache.compress.algorithm # list allowed enum values

A full annotated example lives in the Beez repository at scripts/config.lua.example.

Related pages

• Project Layout - where config.lua and .env live
• Caching - how cache settings affect skip behavior