This document contains the help content for the cherryrgb_ncli
command-line program.
Command Overview:
cherryrgb_ncli
↴cherryrgb_ncli animation
↴cherryrgb_ncli custom-colors
↴cherryrgb_ncli color-profile-file
↴
Client for service-based Cherry RGB Keyboard
Usage: cherryrgb_ncli [OPTIONS] [COMMAND]
animation
— Configure RGB keyboard illuminationcustom-colors
— Configure custom RGB colorscolor-profile-file
— Configure custom RGB colors from file
-
-d
,--debug
— Enable debug output -
-s
,--socket <socket>
— Path of socket to connectDefault value:
/run/cherryrgb.sock
-
-b
,--brightness <BRIGHTNESS>
— Set brightnessDefault value:
full
Possible values:
off
,low
,medium
,high
,full
Configure RGB keyboard illumination
Usage: cherryrgb_ncli animation [OPTIONS] <MODE> <SPEED> [COLOR]
-
<MODE>
— Set LED modePossible values:
wave
,spectrum
,breathing
,static
,radar
,vortex
,fire
,stars
,rain
,rolling
,curve
,wave_mid
,scan
,radiation
,ripples
,single_key
-
<SPEED>
— Set speedPossible values:
very_fast
,fast
,medium
,slow
,very_slow
-
<COLOR>
— Color (e.g ff00ff)
-r
,--rainbow
— Enable rainbow colors
Configure custom RGB colors
Usage: cherryrgb_ncli custom-colors [COLORS]...
<COLORS>
— One or more RGB color specs (6-digit hex numbers)
Configure custom RGB colors from file
Usage: cherryrgb_ncli color-profile-file [OPTIONS] <FILE_PATH>
<FILE_PATH>
— A json encoded file, specifying key colors
-k
,--keep-existing-colors
— If enabled, modifies existing color profile
This document was generated automatically by
clap-markdown
.