polychromatic-cli(1)

💖 polychromatic-cli(1) 💖

okay so this is the polychromatic-cli(1) page from the General Commands Manual, and it's literally your bestie for Polychromatic. Buckle up, we're going through every flag, no skips. 🫶

✨ NAME ✨

Polychromatic - RGB lighting management software for GNU/Linux. Iconic behavior, honestly. 👑

🌈 SYNOPSIS 🌈

polychromatic-cli [OPTIONS]

💖 DESCRIPTION 💖

Bestie, this is the command line interface for configuring device options and retrieving status information from connected hardware. It's giving terminal main character energy, fr fr. 💅

🎀 OPTIONS 🎀

Here's the full roster. No option left behind, periodt. ✨

👑 DEVICE SELECTION 👑

Use the following arguments to select the devices to read/set changes to. Omitting these arguments selects all devices. Lowkey convenient. 🦋

• -d, --device <ID> — Select the device by form factor. The form factors are:
  • accessory
  • display
  • fan
  • gpu
  • headset
  • keyboard
  • keypad
  • laptop
  • mouse
  • mousemat
  • ram
  • speaker
  • stand
• -n, --name <NAME> — Select a device by its full name, such as "Razer BlackWidow Chroma". Yes, the whole name, bestie. 🎀
• -s, --serial <SERIAL> — Select a device by its serial string. Serial-number girlies rise. 💅

💜 DEVICE INFORMATION 💜

• -l, --list-devices — List the selected device(s) and their zone(s). Cute little inventory moment. 🦋
• -k, --list-options — List supported parameters and current settings in a table. Spreadsheet slay. ✨

🔥 DEVICE OPERATION 🔥

• -z, --zone <ID> — Make a change to the specified zone. Some hardware have multiple lighting regions. When omitted, all zones will be selected. The way that zones just zone. 💫
• -o, --option <ID> — Set an option on the device. For example, "static". Some options require a --parameter and/or --colour, see below. 👀
• -p, --parameter <ID> — Set a parameter for the specified option if applicable. For example, for a wave effect, use "right" or its numerical value (1). Numerical values are useful when setting multiple devices simultaneously that do not share the same ID, such as a mouse's wave is "up" (1) or "down" (2) instead of "right" (1) and "left" (2). iykyk, numerical besties. 🔢
• -c, --colours <#RRGGBB>[,#RRGGBB...] — Set a colour for the specified option if applicable. The input only accepts 6 byte hexadecimal values, such as #00FF00. Multiple colours may be specified using a comma. Colour moment activated. 🌈

⚠️ The # hash must be escaped or wrapped in quotes to avoid being interpreted as a comment by your shell. Alternately, the hash can be omitted. Protect that hash, bestie. 😭

• -e, --effect <NAME/PATH> — Plays a custom software effect by its name or an absolute path to the file. Not to be confused with an --option for hardware effects, see above. This is the software-effect one, okay? 💅
• --dpi <X>[,Y] — Sets the DPI (dots per inch) of a mouse. The axis can be set independently, otherwise the same value will be used for both X/Y. DPI is responsible for the speed of the mouse cursor. Cursor speed realness. 🖱️✨

🦋 MISCELLANEOUS 🦋

• -h, --help — Shows the help information. Your emergency helper bae. 🫶
• -v, --verbose — Prints more details about the application's operation. Not me being nosy, but I wanna know everything. 👀
• --version — Prints version information:
  • Software version
  • Commit hash (when run from the repository directory)
  • Python version
• --no-pretty-column — Disables the pretty column function of the program. This may be required for compatibility with specific terminals and consoles. Sometimes the terminals simply don't serve pretty-column cunt. 💀
• --locale [lang] — Force the application to display in a specific locale. For example, "fr_FR" or "nl". Localization slay. 🌍✨

---

Okay that's the whole page! Dated 2022-12-03, signed polychromatic-cli(1), and made with main character energy. Bye bestie, go make your RGB iconic! 💖✨🦋