1PW-CLI(1) General Commands Manual PW-CLI(1)
2
3
4
6 pw-cli - The PipeWire Command Line Interface
7
9 pw-cli [command]
10
11
13 Interact with a PipeWire instance.
14
15 When a command is given, pw-cli will execute the command and exit
16
17 When no command is given, pw-cli starts an interactive session with the
18 default PipeWire instance pipewire-0.
19
20 Connections to other, remote instances can be made. The current in‐
21 stance name is displayed at the prompt. Some commands operate on the
22 current instance and some on the local instance.
23
24 Use the 'help' command to list the available commands.
25
27 help Show a quick help on the commands available.
28
29 quit Exit from pw-cli
30
32 Modules are loaded and unloaded in the local instance and can add
33 functionality or objects to the local instance.
34
35
36 load-module name [arguments...]
37 Load a module specified by its name and arguments. For most mod‐
38 ules it is OK to be loaded more than once.
39
40 This command returns a module variable that can be used to un‐
41 load the module.
42
43 unload-module module-var
44 Unload a module, specified either by its variable.
45
47 list-objects
48 List the objects of the current instance.
49
50 Objects are listed with their id, type and version.
51
52 info id | all
53 Get information about a specific object or all objects.
54
55 Requesting info about an object will also notify you of changes.
56
58 connect [remote-name]
59 Connect to a remote instance and make this the new current in‐
60 stance.
61
62 If no remote name is specified, a connection is made to the de‐
63 fault remote instance, usually pipewire-0.
64
65 This command returns a remote var that can be used to disconnect
66 or switch remotes.
67
68 disconnect [remote-var]
69 Disconnect from a remote instance.
70
71 If no remote name is specified, the current instance is discon‐
72 nected.
73
74 list-remotes
75 List all remote instances.
76
77 switch-remote [remote-var]
78 Make the specified remote the current instance.
79
80 If no remote name is specified, the local instance is made cur‐
81 rent.
82
84 create-node factory-name [properties...]
85 Create a node from a factory in the current instance.
86
87 Properties are key=value pairs separated by whitespace.
88
89 This command returns a node variable.
90
91 destroy-node node-var
92 Destroy a node.
93
94 export-node node-id [remote-var]
95 Export a node from the local instance to the specified instance.
96 When no instance is specified, the node will be exported to the
97 current instance.
98
100 create-link node-id port-id node-id port-id [properties...]
101 Create a link between 2 nodes and ports.
102
103 Port ids can be -1 to automatically select an available port.
104
105 Properties are key=value pairs separated by whitespace.
106
107 This command returns a link variable.
108
109 destroy-link link-var
110 Destroy a link.
111
114 The PipeWire Developers <‐
115 https://gitlab.freedesktop.org/pipewire/pipewire/issues>; PipeWire is
116 available from https://pipewire.org
117
119 pipewire(1), pw-mon(1),
120
121
122
123
124 PW-CLI(1)