Command-Line Interface (CLI) Usage

signalrgb-python provides a user-friendly command-line interface for interacting with your SignalRGB setup. This guide covers the basic usage of the CLI.

🚀 Basic Syntax

The basic syntax for using the SignalRGB CLI is:

signalrgb [OPTIONS] COMMAND [SUBCOMMAND] [ARGS]...

You can always use the --help option to get more information about available commands and options:

signalrgb --help

📋 Available Commands

🎨 Effect Commands

List Effects

To list all available lighting effects:

signalrgb effect list

Get Effect Details

To get detailed information about a specific effect:

signalrgb effect "Effect Name"

Replace "Effect Name" with the name of the effect you want to inspect.

Apply an Effect

To apply a specific effect:

signalrgb effect apply "Effect Name"

Get Current Effect

To see which effect is currently active:

signalrgb effect

Navigate Through Effects

To apply the next effect in history:

signalrgb effect next_effect

To apply the previous effect in history:

signalrgb effect previous_effect

To apply a random effect:

signalrgb effect random

💾 Preset Commands

List Presets

To list presets for the current effect:

signalrgb preset list

Apply a Preset

To apply a preset to the current effect:

signalrgb preset apply "Preset Name"

📐 Layout Commands

List Layouts

To list all available layouts:

signalrgb layout list

Set Current Layout

To set the current layout:

signalrgb layout set "Layout Name"

🎛️ Canvas Commands

Control Brightness

To set the brightness level (0-100):

signalrgb canvas brightness 75

To get the current brightness level:

signalrgb canvas brightness

Enable/Disable Canvas

To enable the canvas:

signalrgb canvas enable

To disable the canvas:

signalrgb canvas disable

To toggle the canvas state:

signalrgb canvas toggle

🌐 Global Options

You can specify a custom host and port for all commands:

signalrgb --host my-pc.local --port 16038 effect list

💡 Examples

Here are some example use cases:

1. List all effects and pipe the output to grep to find a specific effect:

signalrgb effect list | grep "Electric Space"

1. Apply the "Rave Visualizer" effect:

signalrgb effect apply "Rave Visualizer"

1. Get details of the current effect and save it to a file:

signalrgb effect > current_effect.txt

1. Set the brightness to 50% and then disable the canvas:

signalrgb canvas brightness 50
signalrgb canvas disable

1. List layouts and switch to a different one:

signalrgb layout list
signalrgb layout set "Gaming Setup"

1. Create a simple effect cycle script:

#!/bin/bash
# Cycle through 5 random effects
for i in {1..5}; do
  signalrgb effect random
  sleep 5  # Wait 5 seconds between effects
done

Remember to refer to the --help option for each command to see all available options and arguments:

signalrgb effect --help
signalrgb preset --help
signalrgb layout --help
signalrgb canvas --help