repository·main·Indexed 20 days ago
https://github.com/dark-alex-17/managarrA TUI and CLI tool written in Rust for managing Servarr applications, including Radarr, Sonarr, and Lidarr. It provides capabilities to view libraries, manage downloads, trigger searches, and edit indexers. The CLI supports JSON output for automation with tools like jq and can be installed via Cargo, Docker, Homebrew, Nix, or Chocolatey.
Managarr is a Terminal User Interface (TUI) and Command Line Interface (CLI) designed to help manage your Home Theater PC (HTPC) setup. It specifically provides management capabilities for 'Servarr' applications.
Supported Servarrs:
(Note: Readarr, Prowlarr, Whisparr, Bazarr, and Tautulli are listed as planned/not yet supported in the current version).
Managarr supports Radarr, Sonarr, and Lidarr with varying levels of TUI and CLI feature parity.
Managarr includes several built-in themes that are added to your themes.yml on the first startup. You can use these as-is or use them as templates for your own custom themes.
Available built-in themes:
themes.yml file located in the theme's directory. This file defines the visual and structural configuration used by the Managarr TUI when using the default theme settings.To create a custom theme, add a new entry to your themes.yml file. Themes are defined using hex color codes for various TUI elements. If you do not want to use the default themes.yml, you can specify a custom file path using the --themes-file CLI argument.
Note: Some color options may affect more UI elements in future updates as the project evolves.
- name: my-theme
theme:
background:
enabled: true
color: "#233237"
awaiting_import:
color: "#FFAA42"
indeterminate:
color: "#FFAA42"
default:
color: "#FFFFFF"
downloaded:
color: "#00FF00"
downloading:
color: "#762671"
failure:
color: "#DE382B"
help:
color: "#00FFFF"
missing:
color: "#DE382B"
primary:
color: "#2CB5E9"
secondary:
color: "#FFC706"
success:
color: "#39B54A"
system_function:
color: "#FFC706"
unmonitored:
color: "#808080"
unmonitored_missing:
color: "#FFC706"
unreleased:
color: "#00FFFF"
warning:
color: "#FF00FF"Use Chocolatey to install or upgrade Managarr on Windows. Note that new releases may take some time to appear on Chocolatey due to validation processes.
# Install latest
choco install managarr
# Install specific version
choco install managarr --version=0.7.0
# Upgrade to latest
choco upgrade managarr
# Upgrade to specific version
choco upgrade managarr --version=0.7.0To run Managarr in a Docker container, you must first create and populate a config.yml file. You then mount this file to /root/.config/managarr/config.yml inside the container.
Important Notes:
just build-docker.docker run --rm -it -v /home/aclarke/.config/managarr/config.yml:/root/.config/managarr/config.yml darkalex17/managarr:latestYou can download pre-compiled binaries from the GitHub releases page. Supported architectures include:
managarr.exe./usr/local/bin (may require sudo):
tar -C /usr/local/bin -xzf <arch>.tar.gzmanagarr.The Eldritch theme is configured using the themes.yml file located within the theme's directory. To apply or modify the Eldritch theme, you must interact with this configuration file.
# themes/eldritch/themes.yml
# This file contains the configuration for the Eldritch theme.Once a theme is defined in themes.yml, you can activate it using one of two methods:
config.yml file by setting the theme key to your theme's name.--theme flag to quickly test a theme without modifying your configuration.You can also point Managarr to a different themes file entirely using the --themes-file flag.
# In config.yml
theme: my-theme
radarr:
...
sonarr:
...# Via CLI to test a theme
managarr --theme my-theme
# Via CLI to use a specific themes file
managarr --themes-file /path/to/my/testing-themes.ymlManagarr connects to Servarr services (Radarr, Sonarr, Lidarr, etc.) using a YAML configuration file. If you only provide an api_token, Managarr assumes the service is running on localhost using the following default ports:
| Servarr | Default Host | Default Port |
|---|---|---|
| Radarr | localhost | 7878 |
| Sonarr | localhost | 8989 |
| Lidarr | localhost | 8686 |
To find the default configuration file location for your operating system, run:
managarr config-pathradarr:
- api_token: <your-radarr-api-token-here>
sonarr:
- api_token: <your-sonarr-api-token-here>
lidarr:
- api_token: <your-lidarr-api-token-here>For NixOS users, you can install Managarr directly into your environment. For non-NixOS users, you can use nix-shell to spawn a temporary shell containing Managarr.
# NixOS installation
nix-env --install managarr
# Non-NixOS temporary shell
nix-shell -p managarr