Scroll to navigation

OPENRGB(1) User Commands OPENRGB(1)

NAME

openrgb - open source RGB lighting control

SYNOPSIS

openrgb (--device [--mode] [--color])...

DESCRIPTION

OpenRGB 0.9, for controlling RGB lighting.

OPTIONS

Shows the GUI. GUI also appears when not passing any parameters
Starts the GUI minimized to tray. Implies --gui, even if not specified
Starts an SDK client on the given IP:Port (assumes port 6742 if not specified)
Starts the SDK's server
Sets the SDK's server port. Default: 6742 (1024-65535)
Lists every compatible device with their number
Selects device to apply colors and/or effect to, or applies to all devices if omitted
Basic string search is implemented 3 characters or more. Can be specified multiple times with different modes and colors
Selects zone to apply colors and/or sizes to, or applies to all zones in device if omitted
Must be specified after specifying a device
Sets colors on each device directly if no effect is specified, and sets the effect color if an effect is specified
If there are more LEDs than colors given, the last color will be applied to the remaining LEDs
Sets the mode to be applied, check --list-devices to see which modes are supported on your device
Sets the brightness as a percentage if the mode supports brightness
Sets the new size of the specified device zone.
Must be specified after specifying a zone. If the specified size is out of range, or the zone does not offer resizing capability, the size will not be changed

-V, --version Display version and software build information

Load the profile from filename/filename.orp
Save the given settings to profile filename.orp
Shows the I2C/SMBus Tools page in the GUI. Implies --gui, even if not specified.
USE I2C TOOLS AT YOUR OWN RISK! Don't use this option if you don't know what you're doing! There is a risk of bricking your motherboard, RGB controller, and RAM if you send invalid SMBus/I2C transactions.
Use the current working directory instead of the global configuration directory.
Use a custom path instead of the global configuration directory.
Do not try to detect hardware at startup.
Do not try to autoconnect to a local server at startup.
Set the log level (0: fatal to 6: trace).
Print the source code file and line number for each log entry.
Print log messages to stdout.
Print debug messages and log messages to stdout.
Check if OpenRGB starting at login is enabled.
Disable OpenRGB starting at login.
Enable OpenRGB to start at login. Requires arguments to give to OpenRGB at login.

COPYRIGHT

2019-present Adam Honse

December 2024