7 releases

0.1.6 Jun 7, 2024
0.1.5 May 20, 2024
0.1.3 Mar 11, 2024
0.1.2 Jan 26, 2024

#2350 in Command line utilities

MIT license

29KB
571 lines

BAZARR BULK CLI

A CLI tool for performing actions in bulk on Bazarr movies and tv shows. List of supported actions:

  • sync
  • ocr-fixes
  • common-fixes
  • remove-hearing-impaired
  • remove-style-tags
  • reverse-rtl

Installation

Install with cargo

bazarr-bulk is published on crates.io. In order to install a Rust crate from crates.io, it is required to have Rust and cargo installed on your system.

cargo install bazarr-bulk

Manual installation from an archive

Latest release page provides an option to manually install the bb binary from an archive. The archive is available for Linux, MacOS, and Windows. Download, extract and move the binary to the desired directory, and set execution permissions.

Linux

  1. Download the Linux tar.gz archive from the latest release
  2. Extract the archive
tar xf bazarr-bulk_*_x86_64-unknown-linux-musl.tar.gz
  1. Move the binary
sudo mv bb /usr/local/bin
  1. Set execution permissions
sudo chmod +x /usr/local/bin/bb
  1. Run bb
bb --help

MacOS

  1. Download the MacOS (apple-darwin) ZIP archive from the latest release
  2. Extract the archive
unzip bazarr-bulk_*_x86_64-apple-darwin.zip
  1. Move the binary
sudo mv bb /usr/local/bin
  1. Set execution permissions
sudo chmod +x /usr/local/bin/bb
  1. Run bb
bb --help

Windows

  1. Download the Windows ZIP archive from the latest release
  2. Extract the archive
  3. Run bb.exe

Usage

  1. Create a JSON config file based on the template file.
  2. Run bb --config your-config.json [movies|tv-shows] [ACTION]

CLI Manual

bb --help
# Performs bulk operations on subtitles of movies and tv shows using Bazarr's API

Usage: bb --config <FILE> <COMMAND>

Commands:
  movies    Perform operations on movies
  tv-shows  Perform operations on tv shows
  help      Print this message or the help of the given subcommand(s)

Options:
  -c, --config <FILE>  Path to the JSON configuration file
  -h, --help           Print help

Movies

bb movies --help
# Perform operations on movies

Usage: bb --config <FILE> movies [OPTIONS] <COMMAND>

Commands:
  sync                     Sync all
  ocr-fixes                Perform OCR fixes
  common-fixes             Perform common fixes
  remove-hearing-impaired  Remove hearing impaired tags from subtitles
  remove-style-tags        Remove style tags from subtitles
  fix-uppercase            Fix uppercase subtitles
  reverse-rtl              Reverse RTL directioned subtitles
  help                     Print this message or the help of the given subcommand(s)

Options:
      --ids <IDS>        Filter records by Sonarr/Radarr ID (comma-separated)
      --offset <OFFSET>  Skip N records (ignored if ids are specified) [default: skip none] [default: 0]
      --limit <LIMIT>    Limit to N records (ignored if ids are specified) [default: unlimited]
  -h, --help             Print help

TV Shows

bb tv-shows --help
# Perform operations on tv shows

Usage: bb --config <FILE> tv-shows [OPTIONS] <COMMAND>

Commands:
  sync                     Sync all
  ocr-fixes                Perform OCR fixes
  common-fixes             Perform common fixes
  remove-hearing-impaired  Remove hearing impaired tags from subtitles
  remove-style-tags        Remove style tags from subtitles
  fix-uppercase            Fix uppercase subtitles
  reverse-rtl              Reverse RTL directioned subtitles
  help                     Print this message or the help of the given subcommand(s)

Options:
      --ids <IDS>        Filter records by Sonarr/Radarr ID (comma-separated)
      --offset <OFFSET>  Skip N records (ignored if ids are specified) [default: skip none] [default: 0]
      --limit <LIMIT>    Limit to N records (ignored if ids are specified) [default: unlimited]
  -h, --help             Print help

Sync Options

bb movies/tv-shows sync --help
# Customize tv-show/movie subtitle sync options

Usage: bb movies sync [OPTIONS]

Options:
  -r <REFERENCE>       Reference for sync from video file track number (a:0), subtitle (s:0), or some subtitles file path
  -m <MAX OFFSET>      Seconds of offset allowed when syncing [default: null]
  -n                   No fix framerate [default: false]
  -g                   Use Golden-Section search [default: false]
  -h, --help           Print help

Dependencies

~17–31MB
~474K SLoC