Overview of mkbrr command-line interface commands.

CLI Reference

mkbrr

mkbrr: Fast, Simple Torrent Creation & Management

Introduction

How to install mkbrr using various methods.

Installation

Learn how to create .torrent files from local files or directories using the mkbrr create command

Creating torrents

Learn how to view and analyze .torrent file metadata using the mkbrr inspect command

Inspecting torrents

Learn how to update metadata in existing .torrent files using the mkbrr modify command

Modifying torrents

Learn how to verify local files against .torrent files using the mkbrr check command

Checking data integrity

Presets allow you to define and reuse common sets of options for creating or modifying torrents. This is particularly useful if you frequently create torrents for specific trackers with consistent settings.

Presets

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

Batch mode

mkbrr includes built-in knowledge about the specific requirements of various private trackers to help ensure the torrents you create are compliant. When you provide a tracker URL (`-t` flag or via presets/batch), `mkbrr` checks if it matches a known tracker and applies relevant rules automatically.

Tracker rules

When creating a torrent from a directory, `mkbrr` includes a feature to help detect potentially incomplete TV season packs.

Season packs

Control which files are included in your torrent using glob patterns for inclusion and exclusion rules.

Filtering

Performance comparison with other popular torrent creation tools.

Benchmarks

Information on building mkbrr from source, running tests, and contributing.

Development & Contribution

Create a new torrent file from a file or directory.

create

Inspect a torrent file and display its metadata and file structure.

inspect

Modify existing torrent files using a preset or flags.

modify

Verify the integrity of content against a torrent file.

check

Update mkbrr to the latest version from GitHub.

update

Prints the version and build time information for mkbrr.