Browse Source

rename binary: qmk-rgb -> qmk-rgb-tool

Consistent binary name across code, README, AGENTS.md. Fixes collision
between binary name and cloned directory name.
Paul Klumpp 2 weeks ago
parent
commit
2ab76b3618
3 changed files with 53 additions and 53 deletions
  1. 16 16
      AGENTS.md
  2. 35 35
      README.md
  3. 2 2
      cmd/qmk-rgb/main.go

+ 16 - 16
AGENTS.md

@@ -16,21 +16,21 @@ keyboards.json          # VID/PID database + keyboard metadata
 ## CLI Interface
 
 ```
-qmk-rgb keyboard info
-qmk-rgb effect breathing
-qmk-rgb effect rainbow_moving_chevron
-qmk-rgb effect rainbow_moving_chevron --zone backlight
-qmk-rgb brightness <val>       # 0-255
-qmk-rgb speed <val>            # 0-255
-qmk-rgb color <hex>            # Six hexadecimal digits
-qmk-rgb mode <index>           # Raw zone-specific effect ID
-qmk-rgb enable
-qmk-rgb disable
-qmk-rgb info
-qmk-rgb save <name>        # Save current RGB state to a profile
-qmk-rgb load <name>        # Load a profile and apply it to the keyboard
-qmk-rgb delete <name>      # Delete a saved profile
-qmk-rgb list               # List saved profiles
+qmk-rgb-tool keyboard info
+qmk-rgb-tool effect breathing
+qmk-rgb-tool effect rainbow_moving_chevron
+qmk-rgb-tool effect rainbow_moving_chevron --zone backlight
+qmk-rgb-tool brightness <val>       # 0-255
+qmk-rgb-tool speed <val>            # 0-255
+qmk-rgb-tool color <hex>            # Six hexadecimal digits
+qmk-rgb-tool mode <index>           # Raw zone-specific effect ID
+qmk-rgb-tool enable
+qmk-rgb-tool disable
+qmk-rgb-tool info
+qmk-rgb-tool save <name>        # Save current RGB state to a profile
+qmk-rgb-tool load <name>        # Load a profile and apply it to the keyboard
+qmk-rgb-tool delete <name>      # Delete a saved profile
+qmk-rgb-tool list               # List saved profiles
 ```
 
 `--zone` is persistent across commands and accepts `logo`, `backlight`, or `side`.
@@ -109,7 +109,7 @@ prints JSON before returning non-zero.
 Names used in code must appear identically everywhere. Before any edit:
 
 1. **Binary name** — the `go build -o` target (usually `$GOBIN/$module_name`) must match every example in README, AGENTS.md, comments, and docs.
-2. **CLI command** — the root command name (e.g. `qmk-rgb`) is the binary name; every usage example, CLI reference table, and doc must use the same string.
+2. **CLI command** — the root command name (e.g. `qmk-rgb-tool`) is the binary name; every usage example, CLI reference table, and doc must use the same string.
 3. **Module path** — the `go.mod` module path is the source of truth for `go install` targets.
 4. **Zone names** — `logo`, `backlight`, `side` must be identical in code, docs, and examples.
 

+ 35 - 35
README.md

@@ -17,7 +17,7 @@ Build locally:
 ```bash
 git clone <repo-url>
 cd qmk-rgb
-go build -o qmk-rgb ./cmd/qmk-rgb/
+go build -o qmk-rgb-tool ./cmd/qmk-rgb/
 ```
 
 And, to run it from anywhere, install globally (run from the repo root, installs to `$GOPATH/bin/`):
@@ -30,32 +30,32 @@ go install ./cmd/qmk-rgb/
 
 ```bash
 # Discover connected keyboards
-./qmk-rgb keyboard info
+./qmk-rgb-tool keyboard info
 
 # RGB commands target Logo, Backlight, and Side by default
-./qmk-rgb effect breathing
-./qmk-rgb effect rainbow_moving_chevron
-./qmk-rgb effect rainbow_moving_chevron --zone backlight
-./qmk-rgb brightness 160
-./qmk-rgb speed 2
-./qmk-rgb color 00ff00
+./qmk-rgb-tool effect breathing
+./qmk-rgb-tool effect rainbow_moving_chevron
+./qmk-rgb-tool effect rainbow_moving_chevron --zone backlight
+./qmk-rgb-tool brightness 160
+./qmk-rgb-tool speed 2
+./qmk-rgb-tool color 00ff00
 # Raw mode IDs are zone-specific; ID 17 is Backlight-only
-./qmk-rgb mode 17 --zone backlight
-./qmk-rgb enable
-./qmk-rgb disable
-./qmk-rgb info
+./qmk-rgb-tool mode 17 --zone backlight
+./qmk-rgb-tool enable
+./qmk-rgb-tool disable
+./qmk-rgb-tool info
 
 # Select exactly one zone
-./qmk-rgb brightness 160 --zone side
+./qmk-rgb-tool brightness 160 --zone side
 
 # Save and load RGB profiles
-./qmk-rgb save paul
-./qmk-rgb load paul
-./qmk-rgb list
-./qmk-rgb delete paul
+./qmk-rgb-tool save paul
+./qmk-rgb-tool load paul
+./qmk-rgb-tool list
+./qmk-rgb-tool delete paul
 
 # Specify a target device (when multiple are connected)
-./qmk-rgb --device /dev/hidrawX enable
+./qmk-rgb-tool --device /dev/hidrawX enable
 ```
 
 `--zone` is persistent across commands and accepts `logo`, `backlight`, or `side`.
@@ -197,7 +197,7 @@ Create a persistent rule for the Impact 80:
 
 ```bash
 echo 'SUBSYSTEM=="hidraw", ATTRS{idVendor}=="36b0", ATTRS{idProduct}=="309f", MODE="0660", GROUP="adm"' \
-  | sudo tee /etc/udev/rules.d/99-qmk-rgb.rules
+  | sudo tee /etc/udev/rules.d/99-qmk-rgb-tool.rules
 
 sudo udevadm control --reload-rules
 sudo udevadm trigger
@@ -229,22 +229,22 @@ New keyboards can be added to `keyboards.json`.
 
 | Command                         | Description                              |
 |---------------------------------|------------------------------------------|
-| `qmk-rgb keyboard info`          | Discover connected VIA-compatible keyboards |
-| `qmk-rgb keyboard list`          | List all supported keyboards in database  |
-| `qmk-rgb enable`                 | Enable selected lighting zones            |
-| `qmk-rgb disable`                | Disable selected lighting zones           |
-| `qmk-rgb info`                   | Show per-zone RGB state (JSON)            |
-| `qmk-rgb effect <name>`          | Set a zone-aware effect by name           |
-| `qmk-rgb brightness <val>`       | Set brightness (0–255) on selected zones  |
-| `qmk-rgb speed <val>`            | Set effect speed (0–255) on selected zones |
-| `qmk-rgb color <hex>`            | Set color (e.g. `ff0000`) on selected zones |
-| `qmk-rgb mode <index>`           | Set a raw zone-specific effect ID         |
-| `qmk-rgb --zone <zone> ...`      | Target `logo`, `backlight`, or `side`     |
-| `qmk-rgb --device <path> ...`    | Specify HID device path                   |
-| `qmk-rgb save [name]`            | Save current RGB state to `profiles/<name>.json` |
-| `qmk-rgb load [name]`            | Load and apply a profile from `profiles/` |
-| `qmk-rgb list`                   | List saved profiles                        |
-| `qmk-rgb delete [name]`          | Delete a saved profile                     |
+| `qmk-rgb-tool keyboard info`          | Discover connected VIA-compatible keyboards |
+| `qmk-rgb-tool keyboard list`          | List all supported keyboards in database  |
+| `qmk-rgb-tool enable`                 | Enable selected lighting zones            |
+| `qmk-rgb-tool disable`                | Disable selected lighting zones           |
+| `qmk-rgb-tool info`                   | Show per-zone RGB state (JSON)            |
+| `qmk-rgb-tool effect <name>`          | Set a zone-aware effect by name           |
+| `qmk-rgb-tool brightness <val>`       | Set brightness (0–255) on selected zones  |
+| `qmk-rgb-tool speed <val>`            | Set effect speed (0–255) on selected zones |
+| `qmk-rgb-tool color <hex>`            | Set color (e.g. `ff0000`) on selected zones |
+| `qmk-rgb-tool mode <index>`           | Set a raw zone-specific effect ID         |
+| `qmk-rgb-tool --zone <zone> ...`      | Target `logo`, `backlight`, or `side`     |
+| `qmk-rgb-tool --device <path> ...`    | Specify HID device path                   |
+| `qmk-rgb-tool save [name]`            | Save current RGB state to `profiles/<name>.json` |
+| `qmk-rgb-tool load [name]`            | Load and apply a profile from `profiles/` |
+| `qmk-rgb-tool list`                   | List saved profiles                        |
+| `qmk-rgb-tool delete [name]`          | Delete a saved profile                     |
 
 ## Profiles
 

+ 2 - 2
cmd/qmk-rgb/main.go

@@ -19,7 +19,7 @@ var (
 
 func newRootCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:           "qmk-rgb",
+		Use:           "qmk-rgb-tool",
 		Short:         "QMK RGB CLI — control VIA-compatible keyboard lighting",
 		SilenceErrors: true,
 		SilenceUsage:  true,
@@ -128,5 +128,5 @@ func init() {
 	rootCmd.AddCommand(NewProfileDeleteCmd())
 
 	rootCmd.Version = version
-	rootCmd.SetVersionTemplate("	qmk-rgb {{.Version}}\n")
+	rootCmd.SetVersionTemplate("	qmk-rgb-tool {{.Version}}\n")
 }