CLI Getting Started

TsArr includes a command-line interface for interacting with Servarr services directly from your terminal.

Installation

bun add -g tsarr
Copy

Once installed, the tsarr command is available globally.

Quick Start

1. Configure a service

Run the interactive setup wizard:

tsarr config init
Copy

This will prompt you to select services, enter URLs and API keys, and test the connections.

Alternatively, configure manually:

tsarr config set services.radarr.baseUrl http://localhost:7878
tsarr config set services.radarr.apiKey your-api-key
Copy

Or use environment variables:

export TSARR_RADARR_URL=http://localhost:7878
export TSARR_RADARR_API_KEY=your-api-key
Copy

2. Verify connectivity

tsarr doctor
Copy

Output:

radarr     http://localhost:7878     v3.2.2    OK
sonarr     http://localhost:8989     v4.0.1    OK
lidarr     —                                  (not configured)
Copy

3. Start using it

# List all movies
tsarr radarr movie list

# Search for a movie
tsarr radarr movie search "Inception"

# Get system health
tsarr radarr system health

# Show download queue
tsarr radarr queue list
Copy

Command Structure

All service commands follow the same pattern:

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

For example:

tsarr sonarr series list
tsarr radarr movie get 123
tsarr lidarr artist search "Radiohead"
tsarr prowlarr search run "ubuntu iso"
Copy

Output Formats

Control how results are displayed:

Flag	Description
--table	Human-readable table with colors and status indicators (default for TTY)
--json	Pretty-printed JSON (default for non-TTY)
--plain	Tab-separated values, no colors (for piping to awk/cut/sort)
--quiet / -q	Output only IDs
--select	Cherry-pick fields in JSON mode (e.g. --select=title,year)

# Pipe movie IDs into another command
tsarr radarr movie list --quiet | xargs -I {} tsarr radarr movie get {}

# Get JSON for scripting
tsarr sonarr series list --json | jq '.[].title'

# Get only specific fields as JSON
tsarr radarr movie list --json --select=title,year,monitored

# Plain TSV for piping
tsarr radarr movie list --plain | sort -t$'\t' -k3
Copy

Confirmation Prompts

Destructive actions (like delete) require confirmation. Skip the prompt with --yes / -y:

tsarr radarr movie delete 123 --yes
Copy

Shell Completions

Generate completions for your shell:

# Bash
tsarr completions bash >> ~/.bashrc

# Zsh
tsarr completions zsh >> ~/.zshrc

# Fish
tsarr completions fish > ~/.config/fish/completions/tsarr.fish
Copy