@raphiiko/wavelink-cli 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,123 @@
1
+ # @raphiiko/wavelink-cli
2
+
3
+ A command-line interface for controlling Elgato Wave Link 3.0.
4
+
5
+ > **Note:** This CLI is based on Wave Link 3.0 Beta Update 3. Keep in mind things might break with future Wave Link updates.
6
+
7
+ ## Prerequisites
8
+
9
+ - **Elgato Wave Link 3.0** (Beta Update 3 or newer) must be installed and running.
10
+ - **Node.js 18+** or **Bun 1.0+**
11
+
12
+ ## Installation
13
+
14
+ Run directly with `npx`:
15
+
16
+ ```bash
17
+ npx @raphiiko/wavelink-cli <category> <command> [options]
18
+ ```
19
+
20
+ Or install globally:
21
+
22
+ ```bash
23
+ npm install -g @raphiiko/wavelink-cli
24
+ # or
25
+ bun add -g @raphiiko/wavelink-cli
26
+ ```
27
+
28
+ ## Usage
29
+
30
+ ```bash
31
+ wavelink-cli <category> <command> [options]
32
+ ```
33
+
34
+ ### Output Devices
35
+ Manage your output devices (Headphones, Speakers, etc).
36
+
37
+ ```bash
38
+ # List all output devices
39
+ wavelink-cli output list
40
+
41
+ # Assign an output device to a mix
42
+ wavelink-cli output assign <output-id> <mix-id-or-name>
43
+
44
+ # Remove an output device from its mix
45
+ wavelink-cli output unassign <output-id>
46
+
47
+ # Set volume (0-100)
48
+ wavelink-cli output set-volume <output-id> <volume>
49
+
50
+ # Mute/Unmute
51
+ wavelink-cli output mute <output-id>
52
+ wavelink-cli output unmute <output-id>
53
+ ```
54
+
55
+ ### Mixes
56
+ Control your mixes (Stream Mix, Monitor Mix).
57
+
58
+ ```bash
59
+ # List all mixes
60
+ wavelink-cli mix list
61
+
62
+ # Set a device as the ONLY output for a mix
63
+ wavelink-cli mix set-output <mix-id-or-name> <output-id>
64
+
65
+ # Set master volume (0-100)
66
+ wavelink-cli mix set-volume <mix-id-or-name> <volume>
67
+
68
+ # Mute/Unmute/Toggle
69
+ wavelink-cli mix mute <mix-id-or-name>
70
+ wavelink-cli mix unmute <mix-id-or-name>
71
+ wavelink-cli mix toggle-mute <mix-id-or-name>
72
+ ```
73
+
74
+ ### Channels
75
+ Manage audio channels (System, Music, Browser, etc).
76
+
77
+ ```bash
78
+ # List all channels
79
+ wavelink-cli channel list
80
+
81
+ # Set master channel volume (0-100)
82
+ wavelink-cli channel set-volume <channel-id> <volume>
83
+
84
+ # Mute/Unmute/Toggle channel globally
85
+ wavelink-cli channel mute <channel-id>
86
+ wavelink-cli channel unmute <channel-id>
87
+ wavelink-cli channel toggle-mute <channel-id>
88
+
89
+ # Set volume for a specific mix
90
+ wavelink-cli channel set-mix-volume <channel-id> <mix-id-or-name> <volume>
91
+
92
+ # Mute/Unmute in a specific mix
93
+ wavelink-cli channel mute-in-mix <channel-id> <mix-id-or-name>
94
+ wavelink-cli channel unmute-in-mix <channel-id> <mix-id-or-name>
95
+
96
+
97
+ ```
98
+
99
+ ### Inputs
100
+ Control hardware inputs (Microphones, etc).
101
+
102
+ ```bash
103
+ # List all input devices
104
+ wavelink-cli input list
105
+
106
+ # Set gain (0-100)
107
+ wavelink-cli input set-gain <input-id> <gain>
108
+
109
+ # Mute/Unmute
110
+ wavelink-cli input mute <input-id>
111
+ wavelink-cli input unmute <input-id>
112
+ ```
113
+
114
+ ### General
115
+
116
+ ```bash
117
+ # Show Wave Link application info
118
+ wavelink-cli info
119
+ ```
120
+
121
+ ## License
122
+
123
+ MIT