unraidctl

unraidctl

A command-line tool to interact with the Unraid API.

Installation

go install github.com/jwmoss/unraidctl@latest

Or build from source:

git clone https://github.com/jwmoss/unraidctl.git
cd unraidctl
go build -o unraidctl ./cmd/unraidctl

Configuration

Config file (recommended)

Create ~/.config/unraidctl/config.yaml:

server: http://192.168.1.100
api_key: your-api-key-here

Environment variables

export UNRAID_SERVER="http://192.168.1.100"
export UNRAID_API_KEY="your-api-key-here"

Precedence

Flags > Environment variables > Config file

Usage

# Show system information
unraidctl info

# Array management
unraidctl array status
unraidctl array start --force
unraidctl array stop --force

# Docker containers
unraidctl docker list
unraidctl docker start <container>
unraidctl docker stop <container>
unraidctl docker restart <container>

# Virtual machines
unraidctl vm list
unraidctl vm start <name>
unraidctl vm stop <name>

# Shares
unraidctl share list

# Notifications
unraidctl notification list
unraidctl notification dismiss <id>

# JSON output for scripting
unraidctl info --json
unraidctl docker list --json | jq '.[] | .name'

Global Flags

Exit Codes

License

MIT