1PW-CLI(1)                   General Commands Manual                  PW-CLI(1)
2
3
4

NAME

6       pw-cli - The PipeWire Command Line Interface
7

SYNOPSIS

9       pw-cli [command]
10
11

DESCRIPTION

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

GENERAL COMMANDS

27       help | h
28              Show a quick help on the commands available. It also  lists  the
29              aliases for many commands.
30
31       quit | q
32              Exit from pw-cli
33

MODULE MANAGEMENT

35       Modules are loaded and unloaded in the local instance, thus the pw-cli
36       binary itself and can add functionality or objects to the local
37       instance. It is not possible in PipeWire to load modules in another
38       instance.
39
40
41       load-module name [arguments...]
42              Load a module specified by its name and arguments. For most mod‐
43              ules it is OK to be loaded more than once.
44
45              This command returns a module variable that can be used  to  un‐
46              load the module.
47
48       unload-module module-var
49              Unload a module, specified either by its variable.
50

OBJECT INTROSPECTION

52       list-objects
53              List the objects of the current instance.
54
55              Objects are listed with their id, type and version.
56
57       info id | all
58              Get information about a specific object or all objects.
59
60              Requesting info about an object will also notify you of changes.
61

WORKING WITH REMOTES

63       connect [remote-name]
64              Connect  to  a remote instance and make this the new current in‐
65              stance.
66
67              If no remote name is specified, a connection is made to the  de‐
68              fault remote instance, usually pipewire-0.
69
70              This command returns a remote var that can be used to disconnect
71              or switch remotes.
72
73       disconnect [remote-var]
74              Disconnect from a remote instance.
75
76              If no remote name is specified, the current instance is  discon‐
77              nected.
78
79       list-remotes
80              List all remote instances.
81
82       switch-remote [remote-var]
83              Make the specified remote the current instance.
84
85              If  no remote name is specified, the local instance is made cur‐
86              rent.
87

NODE MANAGEMENT

89       create-node factory-name [properties...]
90              Create a node from a factory in the current instance.
91
92              Properties are key=value pairs separated by whitespace.
93
94              This command returns a node variable.
95
96       export-node node-id [remote-var]
97              Export a node from the local instance to the specified instance.
98              When  no instance is specified, the node will be exported to the
99              current instance.
100

DEVICE MANAGEMENT

102       create-device factory-name [properties...]
103              Create a device from a factory in the current instance.
104
105              Properties are key=value pairs separated by whitespace.
106
107              This command returns a device variable.
108
110       create-link node-id port-id node-id port-id [properties...]
111              Create a link between 2 nodes and ports.
112
113              Port ids can be -1 to automatically select an available port.
114
115              Properties are key=value pairs separated by whitespace.
116
117              This command returns a link variable.
118

GLOBALS MANAGEMENT

120       destroy object-id
121              Destroy a global object.
122

PARAMETER MANAGEMENT

124       enum-params object-id param-id
125              Enumerate params of an object.
126
127              param-id can also be given as the param short name.
128
129       set-param object-id param-id param-json
130              Set param of an object.
131
132              param-id can also be given as the param short name.
133

PERMISSION MANAGEMENT

135       permissions client-id object-id permission
136              Set permissions for a client.
137
138              object-id can be -1 to set the default permissions.
139
140       get-permissions client-id
141              Get permissions of a client.
142

COMMAND MANAGEMENT

144       send-command object-id
145              Send a command to an object.
146

EXAMPLES

AUTHORS

149       The                PipeWire                Developers                <‐
150       https://gitlab.freedesktop.org/pipewire/pipewire/issues>;  PipeWire  is
151       available from https://pipewire.org
152

SEE ALSO

154       pipewire(1), pw-mon(1),
155
156
157
158
159                                                                     PW-CLI(1)
Impressum