Batch mode

Batch mode allows you to create multiple torrents from different source paths with varying settings in a single command execution.

Batch mode is ideal for creating multiple torrents in one go.

Configuration File (batch.yaml)

Batch operations are defined in a YAML file, typically named batch.yaml.

Command

mkbrr create -b /path/to/your/batch.yaml

While batch.yaml is a common convention, you can use any filename. Just be sure to specify it with -b.

Configuration Structure

Movies Example

jobs:
  - output: /torrents/movie1.torrent
    path: /media/movies/movie1.mkv
    trackers:
      - https://tracker-one.com/announce/abc
    private: true
    comment: "4K HDR Release"
    source: "UHD"
    
  - output: /torrents/movie2.torrent
    path: /media/movies/movie2.mkv
    trackers:
      - https://tracker-one.com/announce/abc
    private: true
    comment: "1080p Release"
    source: "BluRay"
    
  - output: /torrents/movie3.torrent
    path: /media/movies/movie3.mkv
    trackers:
      - https://tracker-one.com/announce/abc
    private: true
    comment: "720p Release"
    source: "WEB"

Configuration Options

Required Fields

• version: Must be 1
• jobs: List of torrent creation tasks
• output: Path for the .torrent file
• path: Source file/directory path

Optional Settings

• trackers: Announce URLs list
• webseeds: Web seed URLs list
• private: Set to true or false
• piece_length: Piece size exponent

Additional Optional Settings

• comment: Torrent comment string
• source: Source tag string
• no_date: Set true to omit creation date
• exclude_patterns: Glob patterns to exclude files
• include_patterns: Glob patterns to include files

You can find the formal JSON schema for validation here.

You cannot provide a source path argument directly to mkbrr create when using the -b flag. All source paths must be defined within the batch file jobs.