Unraid CLI

A command-line client for interacting with the Unraid API.

Quick Start

1. Add your Unraid server:

unraid config add tower --url https://192.168.1.100 --api-key YOUR_API_KEY

2. List running Docker containers:

unraid docker list

Configuration

The CLI supports multiple server configurations, allowing you to manage several Unraid servers from a single client.

Adding a Server

unraid config add <name> --url <url> --api-key <api-key>

The first server added is automatically set as the default.

Managing Servers

# List all configured servers
unraid config list

# Set a different default server
unraid config default <name>

# Remove a server
unraid config remove <name>

Configuration File

Server configurations are stored in a TOML file:

Platform	Path
Linux	~/.config/unraid/config.toml
macOS	~/Library/Application Support/unraid/config.toml
Windows	C:\Users\<User>\AppData\Roaming\unraid\config.toml

Example configuration:

default = "tower"

[servers.tower]
url = "https://192.168.1.100"
api_key = "your-api-key-here"

[servers.backup]
url = "https://192.168.1.101"
api_key = "another-api-key"

Configuration Priority

The CLI resolves server settings in the following order (highest priority first):

1. CLI arguments (--url, --api-key)
2. Environment variables (UNRAID_URL, UNRAID_API_KEY)
3. Config file (default server or --server flag)

Environment Variables

Variable	Description
UNRAID_URL	Server URL
UNRAID_API_KEY	API key for authentication
UNRAID_SERVER	Server name from config file to use
UNRAID_TIMEOUT	Request timeout in seconds

Commands

Docker

Manage Docker containers on your Unraid server.

# List running containers
unraid docker list

# List all containers (including stopped)
unraid docker list --all
unraid docker ls -a

# Start a container
unraid docker start <name>

# Stop a container
unraid docker stop <name>

# Restart a container
unraid docker restart <name>

# Update a container to the latest image
unraid docker update <name>

Virtual Machines

Manage virtual machines on your Unraid server.

# List running VMs
unraid vm list

# List all VMs (including stopped)
unraid vm list --all
unraid vm ls -a

# Start a VM
unraid vm start <name>

# Stop a VM (graceful shutdown)
unraid vm stop <name>

# Force stop a VM
unraid vm force-stop <name>

# Pause a VM
unraid vm pause <name>

# Resume a paused VM
unraid vm resume <name>

# Reboot a VM
unraid vm reboot <name>

# Reset a VM (hard reboot)
unraid vm reset <name>

Global Options

These options can be used with any command:

# Use a specific server from config
unraid --server backup docker list-containers

# Override URL and API key directly
unraid --url https://192.168.1.100 --api-key YOUR_KEY docker list-containers

# Change the request timeout (default is 5 seconds)
unraid --timeout 10 docker list-containers

License

This project is licensed under the MIT License - see the LICENSE file for details.