# mkbrr

## Docs

- [Introduction](https://mkbrr.com/introduction.md): mkbrr: Fast, Simple Torrent Creation & Management
- [Installation](https://mkbrr.com/installation.md): How to install mkbrr using various methods.
- [GUI Application](https://mkbrr.com/gui/overview.md): mkbrr's graphical user interface for desktop users
- [Creating torrents](https://mkbrr.com/guides/creating-torrents.md): Learn how to create .torrent files from local files or directories using the mkbrr create command
- [Inspecting torrents](https://mkbrr.com/guides/inspecting-torrents.md): Learn how to view and analyze .torrent file metadata using the mkbrr inspect command
- [Modifying torrents](https://mkbrr.com/guides/modifying-torrents.md): Learn how to update metadata in existing .torrent files using the mkbrr modify command
- [Checking data integrity](https://mkbrr.com/guides/checking-data.md): Learn how to verify local files against .torrent files using the mkbrr check command
- [Presets](https://mkbrr.com/features/presets.md): 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.
- [Batch mode](https://mkbrr.com/features/batch-mode.md): Batch mode allows you to create multiple torrents from different source paths with varying settings in a single command execution.
- [Tracker rules](https://mkbrr.com/features/tracker-rules.md): 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.
- [Season packs](https://mkbrr.com/features/season-packs.md): When creating a torrent from a directory, `mkbrr` includes a feature to help detect potentially incomplete TV season packs.
- [Filtering](https://mkbrr.com/features/filtering.md): Control which files are included in your torrent using glob patterns for inclusion and exclusion rules.
- [Benchmarks](https://mkbrr.com/performance/benchmarks.md): Performance comparison with other popular torrent creation tools.
- [Development & Contribution](https://mkbrr.com/development.md): Information on building mkbrr from source, running tests, and contributing.
- [CLI Reference](https://mkbrr.com/cli-reference/introduction.md): Overview of mkbrr command-line interface commands.
- [create](https://mkbrr.com/cli-reference/create.md): Create a new torrent file from a file or directory.
- [inspect](https://mkbrr.com/cli-reference/inspect.md): Inspect a torrent file and display its metadata and file structure.
- [modify](https://mkbrr.com/cli-reference/modify.md): Modify existing torrent files using a preset or flags.
- [check](https://mkbrr.com/cli-reference/check.md): Verify the integrity of content against a torrent file.
- [update](https://mkbrr.com/cli-reference/update.md): Update mkbrr to the latest version from GitHub.
- [version](https://mkbrr.com/cli-reference/version.md): Prints the version and build time information for mkbrr.
- [Changelog](https://mkbrr.com/changelog.md): Latest updates and improvements to mkbrr

## Optional

- [Github](https://github.com/autobrr/mkbrr)
- [Discord](https://discord.gg/WehFCZxq5B)
- [Sponsor](https://github.com/sponsors/s0up4200)