CLI Reference

The uchroma command-line interface provides full control over Razer Chroma devices from your terminal.

Installation

The CLI is included with uchroma. After installing uchroma, the uchroma command is available system-wide.

# Verify installation
uchroma --help

Usage Pattern

uchroma [global options] <command> [command options]

Global Options

Option	Short	Description
--help	-h	Show help message and exit
--device <SPEC>	-d	Select a specific device by index, key, serial, or D-Bus path

Device Selection

When multiple devices are connected, use -d to target a specific one:

# By index (shown in `uchroma list`)
uchroma -d 0 brightness 80

# By device key
uchroma -d blackwidow_v3 fx spectrum

# By serial number
uchroma -d XX1234567890 brightness 100

# By D-Bus path
uchroma -d /io/uchroma/device/0 fx static --color red

If only one device is connected, it is selected automatically.

Command Categories

Device Information

Command	Aliases	Description
list	ls, devices	List connected devices
dump	debug, info	Show detailed device and system info

Lighting Control

Command	Aliases	Description
brightness	bright, br	Get or set device brightness
fx	effect	Apply hardware lighting effects
led	-	Control standalone LEDs (logo, scroll wheel)
matrix	pixels, frame	LED matrix information and direct control

Animation System

Command	Aliases	Description
anim	animation, layer	Manage custom animation layers
input	react, reactive	Configure reactive key effects

Device Management

Command	Aliases	Description
profile	preset, prof	Save and load device presets
power	fan, boost	System control for laptops
battery	bat, wireless	Battery status for wireless devices
watch	monitor, live	Live monitoring of device status

Quick Examples

# List all connected devices
uchroma list

# Set brightness to 75%
uchroma brightness 75

# Apply a spectrum cycling effect
uchroma fx spectrum

# Apply static color
uchroma fx static --color "#ff0088"

# Add a plasma animation layer
uchroma anim add plasma

# Save current settings as a profile
uchroma profile save gaming

# Monitor fan speed in real-time (laptops)
uchroma watch --fan

Exit Codes

Code	Meaning
0	Success
1	Error (device not found, invalid arguments, operation failed)

Environment Variables

Variable	Description
UCHROMA_LOG_LEVEL	Set logging verbosity (DEBUG, INFO, WARNING, ERROR)
NO_COLOR	Disable colored output when set

See Also

• Device Commands - Listing and inspecting devices
• Brightness Control - Brightness management
• Hardware Effects - Built-in lighting effects
• Custom Animations - Animation layer system
• Profiles - Saving and loading configurations
• Power Management - Laptop-specific features
• Advanced Commands - LED, matrix, input, and monitoring