managarr - A TUI and CLI to manage your Servarrs

Managarr is a TUI and CLI to help you manage your HTPC (Home Theater PC). Built with 🤎 in Rust!

What Servarrs are supported?

• [x] Radarr
• [x] Sonarr
• [x] Lidarr
• [ ] Readarr
• [ ] Prowlarr
• [ ] Whisparr
• [ ] Bazarr
• [ ] Tautulli

Try Out the Demo

To try out Managarr before linking it to your HTPC, you can use the purpose built managarr-demo repository. Simply run the following command to start a demo:

curl https://raw.githubusercontent.com/Dark-Alex-17/managarr-demo/main/managarr-demo.sh > /tmp/managarr-demo.sh && bash /tmp/managarr-demo.sh

Alternatively, you can try out the demo container without downloading anything by visiting the Managarr Demo site.

Installation

Cargo

If you have Cargo installed, then you can install Managarr from Crates.io:

cargo install managarr

# If you encounter issues installing, try installing with '--locked'
cargo install --locked managarr

Docker

Run Managarr as a docker container by mounting your config.yml file to /root/.config/managarr/config.yml. For example:

docker run --rm -it -v /home/aclarke/.config/managarr/config.yml:/root/.config/managarr/config.yml darkalex17/managarr:latest

You can also clone this repo and run just build-docker to build a docker image locally and run it using the above command.

Please note that you will need to create and populate your configuration file first before starting the container. Otherwise, the container will fail to start.

Note: If you run into errors using relative file paths when mounting the volume with the configuration file, try using an absolute path.

Homebrew (Mac and Linux)

To install Managarr from Homebrew, install the Managarr tap. Then you'll be able to install Managarr:

brew tap Dark-Alex-17/managarr
brew install managarr

# If you need to be more specific, use the following:
brew install Dark-Alex-17/managarr/managarr

To upgrade to a newer version of Managarr:

brew upgrade managarr

Nix (Externally Maintained)

To install Managarr on NixOS, you can use the following command:

nix-env --install managarr

# Alternatively, for non-NixOS users, you can spawn a temporary shell with Managarr available like so:
nix-shell -p managarr

Chocolatey (Windows)

The Managarr Chocolatey package is located here. Please note that validation of Chocolatey packages take quite some time, and thus the package may not be available immediately after a new release.

choco install managarr

# Some newer releases may require a version number, so you can specify it like so:
choco install managarr --version=0.7.0

To upgrade to the latest and greatest version of Managarr:

choco upgrade managarr

# To upgrade to a specific version:
choco upgrade managarr --version=0.7.0

Manual

Binaries are available on the releases page for the following platforms:

Platform	Architecture(s)
macOS	x86_64, arm64
Linux GNU/MUSL	x86_64,armv6,armv7,aarch64
Windows	x86_64,aarch64

Windows Instructions

To use a binary from the releases page on Windows, do the following:

1. Download the latest binary for your OS.
2. Use 7-Zip or TarTool to unpack the Tar file.
3. Run the executable managarr.exe!

Linux/MacOS Instructions

To use a binary from the releases page on Linux/MacOS, do the following:

1. Download the latest binary for your OS.
2. cd to the directory where you downloaded the binary.
3. Extract the binary with tar -C /usr/local/bin -xzf managarr-<arch>.tar.gz (Note: This may require sudo)
4. Now you can run managarr!

Features

Key:

Symbol	Status
✅	Supported
❌	Missing
🕒	Planned
🚫	Won't Add

Radarr

TUI	CLI	Feature
✅	✅	View your library, downloads, collections, and blocklist
✅	✅	View details of a specific movie including description, history, downloaded file info, or the credits
✅	✅	View details of any collection and the movies in them
🚫	✅	View your host and security configs from the CLI to programmatically fetch the API token, among other settings
✅	✅	Search your library or collections
✅	✅	Add movies to your library
✅	✅	Delete movies, downloads, and indexers
✅	✅	Trigger automatic searches for movies
✅	✅	Trigger refresh and disk scan for movies, downloads, and collections
✅	✅	Manually search for movies
✅	✅	Edit your movies, collections, and indexers
✅	✅	Manage your tags
✅	✅	Manage your root folders
✅	✅	Manage your blocklist
✅	✅	View and browse logs, tasks, events queues, and updates
✅	✅	Manually trigger scheduled tasks

Sonarr

TUI	CLI	Feature
✅	✅	View your library, downloads, blocklist, episodes
✅	✅	View details of a specific series, or episode including description, history, downloaded file info, or the credits
🚫	✅	View your host and security configs from the CLI to programmatically fetch the API token, among other settings
✅	✅	Search your library
✅	✅	Add series to your library
✅	✅	Delete series, downloads, indexers, root folders, and episode files
✅	✅	Trigger automatic searches for series, seasons, or episodes
✅	✅	Trigger refresh and disk scan for series and downloads
✅	✅	Manually search for series, seasons, or episodes
✅	✅	Edit your series and indexers
✅	✅	Manage your tags
✅	✅	Manage your root folders
✅	✅	Manage your blocklist
✅	✅	View and browse logs, tasks, events queues, and updates
✅	✅	Manually trigger scheduled tasks

Lidarr

TUI	CLI	Feature
✅	✅	View your library, downloads, blocklist, tracks
✅	✅	View details of a specific artists, albums, or tracks including description, history, downloaded file info
🚫	✅	View your host and security configs from the CLI to programmatically fetch the API token, among other settings
✅	✅	Search your library
✅	✅	Add artists to your library
✅	✅	Delete artists, downloads, indexers, root folders, and track files
✅	✅	Trigger automatic searches for artists or albums
✅	✅	Trigger refresh and disk scan for artists and downloads
✅	✅	Manually search for full artist discographies or albums
✅	✅	Edit your artists and indexers
✅	✅	Manage your tags
✅	✅	Manage your root folders
✅	✅	Manage your blocklist
✅	✅	View and browse logs, tasks, events queues, and updates
✅	✅	Manually trigger scheduled tasks

Readarr

• [ ] Support for Readarr

Whisparr

• [ ] Support for Whisparr

Bazarr

• [ ] Support for Bazarr

Prowlarr

• [ ] Support for Prowlarr

Tautulli

• [ ] Support for Tautulli

Themes

Managarr ships with a few themes out of the box. Here's a few examples:

Default

Dracula

Watermelon Dark

You can also create your own custom themes as well. To learn more about what themes are built-in to Managarr and how to create your own custom themes, check out the Themes README.

The Managarr CLI

Managarr can be used in one of two ways: As a TUI, or as a CLI for managing your Servarrs.

All management features available in the TUI are also available in the CLI. However, the CLI is equipped with additional features to allow for more advanced usage and automation.

The CLI can be helpful for automating tasks or for use in scripts. For example, you can use the CLI to trigger a search for a movie, or to add a movie to your Radarr library.

To see all available commands, simply run `man