Configuration
Learn about the presets.yaml file structure
Options
Available preset configuration options
Usage
How to use presets in commands
Overrides
Command-line flag precedence
Configuration File (presets.yaml
)
Presets are defined in a YAML file named
presets.yaml
. mkbrr
searches for this file in the following locations, using the first one it finds:- Path specified by the
--preset-file
flag (if used) - The current working directory (
./presets.yaml
) ~/.config/mkbrr/presets.yaml
(or equivalent user config directory)~/.mkbrr/presets.yaml
(legacy location)
Structure
Thepresets.yaml
file follows this structure:
Configuration Fields
Available Options
The following options can be used within thedefault
section or any specific preset:
- Core Options
- Piece Settings
- File Control
- Advanced
You can find the formal JSON schema for validation here.
Using Presets
Specify the preset name using the-P
(or --preset
) flag with the create
or modify
commands:
Overriding Presets
Command-line flags take precedence over preset settings. Most flags completely override their preset counterparts, but filtering options have special behavior:- Filtering patterns are additive: Command-line patterns combine with preset patterns
Example: Combining Preset and Command-line Filters
Example: Combining Preset and Command-line Filters
Preset Definition
Command with Additional Filters
Standard command-line flags (like
--private
or --source
) completely override their preset values, while filtering patterns combine additively.For complete details on filter processing and pattern syntax, see the Filtering documentation.