@raphiiko/wavelink-cli 0.0.5 → 0.0.7

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Raphiiko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,12 +1,16 @@
 # @raphiiko/wavelink-cli
 
+[![npm version](https://img.shields.io/npm/v/@raphiiko/wavelink-cli.svg)](https://www.npmjs.com/package/@raphiiko/wavelink-cli)
+[![npm downloads](https://img.shields.io/npm/dm/@raphiiko/wavelink-cli.svg)](https://www.npmjs.com/package/@raphiiko/wavelink-cli)
+[![license](https://img.shields.io/npm/l/@raphiiko/wavelink-cli.svg)](https://github.com/Raphiiko/wavelink-cli/blob/main/LICENSE)
+
 A command-line interface for controlling Elgato Wave Link 3.0.
 
-> **Note:** This CLI is based on Wave Link 3.0 Beta Update 3. Keep in mind things might break with future Wave Link updates.
+> **Note:** This CLI is based on Wave Link 3.0 Beta Update 4. Keep in mind things might break with future Wave Link updates.
 
 ## Prerequisites
 
-- **Elgato Wave Link 3.0** (Beta Update 3 or newer) must be installed and running.
+- **Elgato Wave Link 3.0** (Beta Update 4 or newer) must be installed and running.
 - **Node.js 18+** or **Bun 1.0+**
 
 ## Installation
@@ -35,22 +39,26 @@ wavelink-cli <category> <command> [options]
 Manage your output devices (Headphones, Speakers, etc).
 
 ```bash
-# List all output devices
+# List all output devices (shows names, IDs, and Wave Device status)
 wavelink-cli output list
 
-# Assign an output device to a mix
-wavelink-cli output assign <output-id> <mix-id-or-name>
+# Assign an output device to a mix (use ID or name)
+wavelink-cli output assign <output-id-or-name> <mix-id-or-name>
+# Example: wavelink-cli output assign "Headphones (Arctis Nova Pro Wireless)" "Stream Mix"
 
 # Remove an output device from its mix
-wavelink-cli output unassign <output-id>
+wavelink-cli output unassign <output-id-or-name>
+# Example: wavelink-cli output unassign "Speakers (Realtek)"
 
 # Set volume (0-100)
-wavelink-cli output set-volume <output-id> <volume>
+wavelink-cli output set-volume <output-id-or-name> <volume>
+# Example: wavelink-cli output set-volume "Headphones (Arctis Nova Pro Wireless)" 75
 
 # Mute/Unmute
-wavelink-cli output mute <output-id>
-wavelink-cli output unmute <output-id>
-wavelink-cli output toggle-mute <output-id>
+wavelink-cli output mute <output-id-or-name>
+wavelink-cli output unmute <output-id-or-name>
+wavelink-cli output toggle-mute <output-id-or-name>
+# Example: wavelink-cli output toggle-mute "Speakers (Realtek)"
 ```
 
 ### Mixes
@@ -62,59 +70,67 @@ wavelink-cli mix list
 
 # Set a device as the ONLY output for a mix
 wavelink-cli mix set-output <mix-id-or-name> <output-id>
+# Example: wavelink-cli mix set-output "Stream Mix" "{0.0.0.00000000}.{abc12345-...}"
 
 # Set master volume (0-100)
 wavelink-cli mix set-volume <mix-id-or-name> <volume>
+# Example: wavelink-cli mix set-volume "Personal Mix" 80
 
 # Mute/Unmute/Toggle
 wavelink-cli mix mute <mix-id-or-name>
 wavelink-cli mix unmute <mix-id-or-name>
 wavelink-cli mix toggle-mute <mix-id-or-name>
+# Example: wavelink-cli mix toggle-mute "Monitor Mix"
 ```
 
 ### Channels
 Manage audio channels (System, Music, Browser, etc).
 
 ```bash
-# List all channels
+# List all channels (shows names and IDs)
 wavelink-cli channel list
 
-# Set master channel volume (0-100)
-wavelink-cli channel set-volume <channel-id> <volume>
+# Set master channel volume (0-100, use ID or name)
+wavelink-cli channel set-volume <channel-id-or-name> <volume>
+# Example: wavelink-cli channel set-volume "Game Audio" 70
 
 # Mute/Unmute/Toggle channel globally
-wavelink-cli channel mute <channel-id>
-wavelink-cli channel unmute <channel-id>
-wavelink-cli channel toggle-mute <channel-id>
+wavelink-cli channel mute <channel-id-or-name>
+wavelink-cli channel unmute <channel-id-or-name>
+wavelink-cli channel toggle-mute <channel-id-or-name>
+# Example: wavelink-cli channel toggle-mute "Voice Chat"
 
 # Set volume for a specific mix
-wavelink-cli channel set-mix-volume <channel-id> <mix-id-or-name> <volume>
+wavelink-cli channel set-mix-volume <channel-id-or-name> <mix-id-or-name> <volume>
+# Example: wavelink-cli channel set-mix-volume browser "Stream Mix" 60
 
 # Mute/Unmute in a specific mix
-wavelink-cli channel mute-in-mix <channel-id> <mix-id-or-name>
-wavelink-cli channel unmute-in-mix <channel-id> <mix-id-or-name>
-wavelink-cli channel toggle-mute-in-mix <channel-id> <mix-id-or-name>
+wavelink-cli channel mute-in-mix <channel-id-or-name> <mix-id-or-name>
+wavelink-cli channel unmute-in-mix <channel-id-or-name> <mix-id-or-name>
+wavelink-cli channel toggle-mute-in-mix <channel-id-or-name> <mix-id-or-name>
+# Example: wavelink-cli channel toggle-mute-in-mix game "Monitor Mix"
 
 # Isolate a channel in a mix (mute all others)
-wavelink-cli channel isolate <channel-id> <mix-id-or-name>
-
-
+wavelink-cli channel isolate <channel-id-or-name> <mix-id-or-name>
+# Example: wavelink-cli channel isolate voice "Personal Mix"
 ```
 
 ### Inputs
 Control hardware inputs (Microphones, etc).
 
 ```bash
-# List all input devices
+# List all input devices (shows names, IDs, gain ranges, gain lock status, and mic/PC mix settings)
 wavelink-cli input list
 
-# Set gain (0-100)
-wavelink-cli input set-gain <input-id> <gain>
+# Set gain (0-100, use ID or name)
+wavelink-cli input set-gain <input-id-or-name> <gain>
+# Example: wavelink-cli input set-gain "Microphone (Blue Yeti)" 65
 
 # Mute/Unmute
-wavelink-cli input mute <input-id>
-wavelink-cli input unmute <input-id>
-wavelink-cli input toggle-mute <input-id>
+wavelink-cli input mute <input-id-or-name>
+wavelink-cli input unmute <input-id-or-name>
+wavelink-cli input toggle-mute <input-id-or-name>
+# Example: wavelink-cli input toggle-mute "Wave:3"
 ```
 
 ### General