Tsarr

TypeScript-arr (pronounced "Tsar" /tsɑr/ - a Slavic king/emperor)

A Radarr CLI, Sonarr CLI, and type-safe TypeScript SDK for the entire Servarr ecosystem.

Tsarr is a unified command-line tool and TypeScript SDK for managing Radarr, Sonarr, Lidarr, Readarr, Prowlarr, and Bazarr. Auto-generated from official OpenAPI specs, it gives you type-safe API clients and a powerful CLI to manage your entire *arr media stack from code or the terminal.

Why Tsarr?

• The only type-safe TypeScript client for all Servarr apps in one package
• Always up-to-date — generated from official Swagger/OpenAPI specs, not manually maintained
• CLI + SDK — use it as a standalone Radarr/Sonarr CLI tool or import it as a library in your code
• Zero dependencies for binaries — standalone binaries for every platform, or run via Node.js/Bun
• Built for automation — JSON output, scripting-friendly, perfect for cron jobs and CI/CD pipelines

Features

• 🛡️ Type-safe - Generated from official Swagger/OpenAPI specs
• ⚡ Universal - Works with Node.js, Bun, and as standalone binaries
• 📦 Modular - Separate clients for each Servarr app
• 💻 CLI included - Manage all Servarr apps from the terminal
• 🚀 Multi-platform - Available via npm, Homebrew, Docker, Scoop, Chocolatey, AUR, Nix, and pre-built binaries

Supported Servarr Apps

• Radarr - Movie collection manager
• Sonarr - TV series collection manager
• Lidarr - Music collection manager
• Readarr - Book collection manager
• Prowlarr - Indexer manager
• Bazarr - Subtitle manager

Installation

npm / Node.js

# As a dependency (SDK)
npm install tsarr

# As a global CLI
npm install -g tsarr

# Or run directly without installing
npx tsarr doctor
Copy

Bun

bun add tsarr
bun add -g tsarr
bunx tsarr doctor
Copy

Homebrew (macOS / Linux)

brew install robbeverhelst/tsarr/tsarr
Copy

OpenClaw / ClawHub

Install the published OpenClaw skill to manage your Servarr stack through TsArr:

openclaw clawhub install tsarr
# or with the registry CLI
clawhub install tsarr
Copy

Pre-built Binaries

Download standalone binaries from GitHub Releases — no runtime needed:

Platform	Download
macOS (Apple Silicon)	tsarr-darwin-arm64
macOS (Intel)	tsarr-darwin-x64
Linux (x64)	tsarr-linux-x64
Linux (arm64)	tsarr-linux-arm64
Windows (x64)	tsarr-windows-x64.exe

# Example: Linux x64
curl -L https://github.com/robbeverhelst/tsarr/releases/latest/download/tsarr-linux-x64 -o tsarr
chmod +x tsarr
sudo mv tsarr /usr/local/bin/
Copy

Docker

docker run --rm ghcr.io/robbeverhelst/tsarr doctor
docker run --rm -v ~/.config/tsarr:/root/.config/tsarr ghcr.io/robbeverhelst/tsarr radarr movie list
Copy

Scoop (Windows)

Note: Requires adding the tsarr bucket first.

scoop bucket add tsarr https://github.com/robbeverhelst/scoop-tsarr
scoop install tsarr
Copy

Chocolatey (Windows)

Note: Chocolatey packaging is prepared but may still be pending moderation. See docs/distribution.md.

choco install tsarr
Copy

AUR (Arch Linux)

yay -S tsarr-bin
Copy

Nix

Install the repo flake directly:

nix profile install github:robbeverhelst/tsarr?dir=packaging/nix
# or run it without installing
nix run github:robbeverhelst/tsarr?dir=packaging/nix -- doctor
Copy

The committed flake under packaging/nix/flake.nix tracks the latest published release. Shared nixpkgs distribution still requires a maintainer submission. See docs/distribution.md for the full distribution flow.

CLI

Setup

# Interactive setup wizard
tsarr config init

# Or configure manually
tsarr config set services.radarr.baseUrl http://localhost:7878
tsarr config set services.radarr.apiKey your-api-key

# Or use environment variables
export TSARR_RADARR_URL=http://localhost:7878
export TSARR_RADARR_API_KEY=your-api-key
Copy

Config is stored in ~/.config/tsarr/config.json (global) or .tsarr.json (local project). Environment variables take priority over config files.

Usage

tsarr <service> <resource> <action> [options]

# Examples
tsarr radarr movie list
tsarr radarr movie search --term "Interstellar"
tsarr sonarr series list
tsarr prowlarr indexer list
tsarr lidarr artist search --term "Radiohead"

# Output formats
tsarr radarr movie list --table    # Table (default in terminal)
tsarr radarr movie list --json     # JSON (default when piped)
tsarr radarr movie list --quiet    # IDs only

# Diagnostics
tsarr doctor                       # Test all configured connections

# Shell completions
tsarr completions bash >> ~/.bashrc
tsarr completions zsh >> ~/.zshrc
tsarr completions fish > ~/.config/fish/completions/tsarr.fish
Copy

Available Commands

Service	Resources
radarr	movie, profile, tag, queue, rootfolder, system, history, customformat
sonarr	series, episode, profile, tag, rootfolder, system
lidarr	artist, album, profile, tag, rootfolder, system
readarr	author, book, profile, tag, rootfolder, system
prowlarr	indexer, search, app, tag, system
bazarr	series, movie, episode, provider, language, system

See the CLI Guide for full documentation including all commands, scripting examples, and shell completions.

SDK

Quick Start

import { RadarrClient, SonarrClient, LidarrClient } from 'tsarr';

const radarr = new RadarrClient({
  baseUrl: 'http://localhost:7878',
  apiKey: 'your-api-key'
});

// Type-safe API calls
const movies = await radarr.getMovies();
const status = await radarr.getSystemStatus();
Copy

Modular Imports

// Import only what you need
import { RadarrClient } from 'tsarr/radarr';
import { SonarrClient } from 'tsarr/sonarr';
import type { MovieResource } from 'tsarr/radarr/types';
Copy

Development

Install dependencies:

bun install
Copy

Run development server:

bun run dev
Copy

Build the project:

bun run build
Copy

Lint and format:

bun run lint
bun run format
Copy

📖 Documentation

• CLI Guide - Complete CLI documentation with all commands and scripting examples
• SDK Usage Guide - SDK usage documentation with examples
• API Documentation - Auto-generated TypeScript API docs
• Examples - Real-world automation examples
• Examples Directory - Runnable example scripts

Use Cases

Perfect for building:

• Automation scripts - Bulk movie imports, library maintenance, and media organization
• Management tools - Custom dashboards, backup utilities, and monitoring scripts
• Integration scripts - Connect Servarr apps with other services and workflows
• CLI usage - Manage your media servers directly from the terminal

Alternatives

Looking for a Radarr CLI or Sonarr API client? Here's how Tsarr compares:

Feature	Tsarr	Manual API calls
Type safety	✅ Full TypeScript types	❌ None
All *arr apps	✅ 6 apps in one package	⚠️ DIY per app
CLI included	✅ Built-in	❌ No
Auto-generated	✅ From official specs	❌ Manual
Runtime	Node.js / Bun / standalone	curl
Package managers	npm, Homebrew, Docker, AUR, Nix, Scoop	N/A

Contributing

This project uses:

• Bun as the JavaScript runtime
• Biome for linting and formatting
• @hey-api/openapi-ts for code generation
• Renovate for dependency updates

License

MIT - see LICENSE file for details.

---

_{Search terms: radarr cli · sonarr cli · lidarr cli · readarr cli · prowlarr cli · bazarr cli · servarr api client · arr typescript · selfhosted media automation}