Skip to main content

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:

Structure

The presets.yaml file follows this structure:
integer
required
Must be 1
object
Optional settings applied to all presets unless explicitly overridden within a specific preset
object
required
A map where each key is the preset name (e.g., ptp, public) and the value contains the options for that preset

Available Options

The following options can be used within the default section or any specific preset:
string[]
List of announce URLs. The first one is used as the primary tracker.
boolean
Whether the torrent should be private.
string
Source tag string.
string
Torrent comment string.
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
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.