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