Presets

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:

# yaml-language-server: $schema=https://raw.githubusercontent.com/autobrr/mkbrr/main/schema/presets.json
version: 1

# Optional: Default settings applied to ALL presets unless overridden
default:
  private: true
  no_date: true
  no_creator: false
  skip_prefix: false
  # comment: "Default comment"
  # source: "DEFAULT_SRC"
  # exclude_patterns: ["*.bak", "temp.*"]
  # include_patterns: ["*.mkv", "*.mp4"]

presets:
  preset-name-1: # Name of the preset (used with -P flag)
    trackers:
      - "https://tracker-one.com/announce/..."
    source: "TRACKER1"
    comment: "Uploaded via mkbrr"
    private: true
    exclude_patterns:
      - "*.nfo"
      - "*sample*"

  preset-name-2:
    trackers:
      - "udp://tracker-two.org:6969/announce"
    private: false # Make these torrents public
    piece_length: 18 # Use 256 KiB pieces for this preset
    include_patterns:
      - "*.mkv"
      - "*.mp4"
      - "*.avi"

version: 1
presets:
  ptp:
    trackers:
      - "https://tracker.example.com/announce"
    private: false
    source: "EXAMPLE"

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:

Core Options
Piece Settings
File Control
Advanced

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.

integer

Piece size exponent (e.g., 18 for 256 KiB). Accepts 16-27, or 14-27 for a tracker with its own piece size table. Mutually exclusive with target_piece_count.

integer

Target approximate number of pieces (e.g., 600 or 900). Calculates the optimal piece length automatically. Mutually exclusive with piece_length.

integer

Maximum piece size exponent for automatic calculation. Accepts 16-27, or 14-27 for a tracker with its own piece size table when target piece count is not set.

string[]

List of glob patterns to exclude files.

string[]

List of glob patterns to include files (takes precedence over exclude).

boolean

Leave out the filename prefix from the output filename. In create, the filename prefix is the tracker domain. In modify, it is the preset name. Both commands read this key.

string

Output directory for created torrents.

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:

mkbrr create /path/to/content -P preset-name-1

mkbrr modify *.torrent -P preset-name-2

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

Preset Definition

presets:
  movies:
    include_patterns:
      - "*.mkv"
      - "*.mp4"
    exclude_patterns:
      - "*sample*"

Command with Additional Filters

# This combines the preset patterns with command-line patterns
mkbrr create /path/to/content -P movies --include "*.srt" --exclude "*.nfo"

# Effective filters applied:
# include_patterns: ["*.mkv", "*.mp4", "*.srt"]
# exclude_patterns: ["*sample*", "*.nfo"]

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.

mkbrr create /path/to/content -P preset-name-1 -s "CUSTOM_SRC"

mkbrr modify existing.torrent -P preset-name-2 --private=true

Presets with modify

modify gets each setting from the first source in this list that has it:

The command-line flag.
The preset.
The torrent that you modify.

If the preset does not have a key, modify keeps the value from the torrent. Tracker defaults do not apply to modify. A tracker default is a value that mkbrr knows for a tracker, such as its source tag. If the preset sets a key to false, modify uses that value. For example, no_creator: false writes the creator string. A preset cannot remove the source, the comment, or the private flag. To remove them, use --source "", --comment "", or --no-private.

Get Started

Usage

Features

Performance

Development

Configuration

Options

Usage

Overrides

Configuration File (`presets.yaml`)

Structure

Available Options

Using Presets

Overriding Presets

Presets with modify

Configuration

Options

Usage

Overrides

​Configuration File (presets.yaml)

​Structure

​Available Options

​Using Presets

​Overriding Presets

​Presets with modify

Configuration File (`presets.yaml`)

Structure

Available Options

Using Presets

Overriding Presets

Presets with modify