eruptionctl - A CLI control utility for the Eruption Linux user-mode driver

This is the command line interface to the Eruption daemon

Example usage

$ eruptionctl switch profile swirl-perlin-blue-red-dim.profile 

$ eruptionctl switch slot 4

$ eruptionctl config brightness 100

$ eruptionctl status profile
Current profile: /var/lib/eruption/profiles/swirl-perlin-blue-red-dim.profile

$ eruptionctl devices debounce 1
Selected device: ROCCAT Kone Pure Ultra (1)
Debounce: true

$ eruptionctl devices brightness 1 20
Selected device: ROCCAT Kone Pure Ultra (1)

$ eruptionctl rules list
  0: On window focused: Name: '.*YouTube.*Chrome' => Switch to profile: /var/lib/eruption/profiles/spectrum-analyzer-swirl.profile (enabled: true, internal: false)
  1: On window focused: Instance: 'Steam' => Switch to profile: /var/lib/eruption/profiles/gaming.profile (enabled: true, internal: false)
  2: On window focused: Instance: 'vlc' => Switch to profile: /var/lib/eruption/profiles/spectrum-analyzer-swirl.profile (enabled: true, internal: false)
  3: On window focused: Name: 'Skype' => Switch to profile: /var/lib/eruption/profiles/vu-meter.profile (enabled: false, internal: false)
  4: On window focused: Instance: 'totem' => Switch to profile: /var/lib/eruption/profiles/spectrum-analyzer-swirl.profile (enabled: true, internal: false)
  5: On window focused: Instance: '.*' => Switch to profile: /var/lib/eruption/profiles/swirl-perlin-blue-red-dim.profile (enabled: true, internal: true)

$ eruptionctl rules add window-instance '.*vlc.*' /var/lib/eruption/profiles/spectrum-analyzer-swirl.profile

$ eruptionctl rules remove 5

eruptionctl

$ eruptionctl

Eruption is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Eruption is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with Eruption.  If not, see <http://www.gnu.org/licenses/>.

Copyright (c) 2019-2022, The Eruption Development Team
A CLI control utility for the Eruption Linux user-mode driver

Usage: eruptionctl [OPTIONS] <COMMAND>

Commands:
  status         Shows the currently active profile or slot
  switch         Switch to a different profile or slot
  config         Configuration related sub-commands
  devices        Get or set some device specific configuration parameters
  profiles       Profile related sub-commands
  scripts        Script related sub-commands
  color-schemes  Define, import or delete a named color scheme
  param          Get or set script parameters on the currently active profile
  names          Naming related commands such as renaming of profile slots
  effects        Special effects like Ambient, image overlays or animations
  rules          Rules related sub-commands
  help           Print this message or the help of the given subcommand(s)

Options:
  -v, --verbose...       Verbose mode (-v, -vv, -vvv, etc.)
  -r, --repeat           Repeat output until ctrl+c is pressed
  -c, --config <CONFIG>  Sets the configuration file to use
  -h, --help             Print help information
  -V, --version          Print version information