OPENRGB(1)

💖 OPENRGB — bestie's guide to making ur lights go slay 💖

okay so. this is the manual page for openrgb (that's section 1 of the manual, bestie, the "user commands" section ✨). it's open source RGB lighting control and honestly? it ate. let's get into it 🫶

✨ NAME ✨

openrgb — open source RGB lighting control 🌈

🎀 SYNOPSIS 🎀

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

like. that's the whole vibe. device, mode, color. rinse and repeat, as many times as your little heart desires 💅

🦋 DESCRIPTION 🦋

OpenRGB 0.9, for controlling RGB lighting.

that's it, that's the girl. she controls ur lights. periodt. 👑

💅 OPTIONS 💅

okay this is the part where u actually read, bestie, i'm not gonna sugarcoat it — every single one of these matters 🙈

• --gui — shows the GUI. also, plot twist: the GUI pops up anyway if u don't pass any parameters at all. she's eager like that.
• --startminimized — starts the GUI minimized down to the tray. this one implies --gui, even if u didn't say it. she just knows.
• --client [IP]:[Port] — starts an SDK client on the IP:Port u give it. if u don't give a port, she assumes 6742. generous queen.
• --server — starts the SDK's server. she's serving, literally 🍓
• --server-port — sets the SDK's server port. default: 6742, and it lives in the range 1024-65535.
• -l, --list-devices — lists every compatible device with their number. go look at ur children, bestie 🥹
• -d, --device [0-9 | "name"] — picks the device u wanna apply colors and/or an effect to. if u just. don't include it? it applies to all the devices. every last one. no cap.

basic string search kicks in at 3 characters or more. and yes u can specify it multiple times with different modes and colors. stack that.

• -z, --zone [0-9] — picks the zone to apply colors and/or sizes to. omit it and it hits every zone in the device.

⚠️ must be specified after specifying a device. order matters, bestie, she's not flexible on this one.

• -c, --color [random | FFFFF,00AAFF ...] — sets colors on each device directly if there's no effect specified, and sets the effect color if there is an effect specified.

if there are more LEDs than colors u gave? the last color gets applied to all the leftover LEDs. she fills in the gaps, iconic.

• -m, --mode [breathing | static | ...] — sets the mode to be applied. check --list-devices to see which modes ur device actually supports. don't come for her if ur hardware is basic 💀
• -b, --brightness [0-100] — sets the brightness as a percentage, but only if the mode supports brightness. know ur limits.
• -s, --size [0-N] — sets the new size of the specified device zone.

⚠️ must be specified after specifying a zone. and if the size u give is out of range, or the zone just doesn't offer resizing capability at all? the size will not be changed. she's not gonna force it. respect.

• -V, --version — displays the version and software build information. show me the receipts ✨
• -p, --profile filename[.orp] — loads the profile from filename / filename.orp.
• -sp, --save-profile filename.orp — saves the settings u just gave her into the profile filename.orp.
• --i2c-tools — shows the I2C/SMBus Tools page in the GUI. implies --gui, even if u didn't say it.

🚨 USE I2C TOOLS AT YOUR OWN RISK! don't use this option if u don't know what ur doing! there is a risk of bricking ur motherboard, ur RGB controller, and ur RAM if u send invalid SMBus/I2C transactions. i am not playing, bestie. this is the one place where the vibe check is a hard no. 😭

• --localconfig — uses the current working directory instead of the global configuration directory.
• --config path — uses a custom path instead of the global configuration directory. ur path, ur rules 💜
• --nodetect — do not try to detect hardware at startup. she'll keep her hands to herself.
• --noautoconnect — do not try to autoconnect to a local server at startup.
• --loglevel [0-6 | error | warning ...] — sets the log level. for the numbers girlies: 0 is fatal, all the way up to 6 which is trace. u can also just say error, warning, etc. 🌸
• --print-source — prints the source code file and line number for each log entry. very main character detective energy 🔍
• -v, --verbose — prints log messages to stdout.
• -vv, --very-verbose — prints debug messages and log messages to stdout. double v, double the tea.
• --autostart-check — checks if OpenRGB starting at login is enabled.
• --autostart-disable — disables OpenRGB starting at login.
• --autostart-enable arguments — enables OpenRGB to start at login. requires arguments — the ones u want to hand to OpenRGB at login. she needs instructions, bestie 🎀

👑 COPYRIGHT 👑

2019-present Adam Honse

that's the whole page, bestie 🫶 this was the OPENRGB(1) manual, dated December 2024 — go make ur setup gorgeous, and pls pls pls be careful with the I2C tools. mwah 💋✨