pw-cli(1)

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   Show a quick help on the commands available.
28
29       quit   Exit from pw-cli
30

MODULE MANAGEMENT

32       Modules are loaded and unloaded in the local instance and can add functionality or objects to the local instance.
33
34
35       load-module name [arguments...]
36              Load a module specified by its name and arguments. For most mod‐
37              ules it is OK to be loaded more than once.
38
39              This  command  returns a module variable that can be used to un‐
40              load the module.
41
42       unload-module module-var
43              Unload a module, specified either by its variable.
44

OBJECT INTROSPECTION

46       list-objects
47              List the objects of the current instance.
48
49              Objects are listed with their id, type and version.
50
51       info id | all
52              Get information about a specific object or all objects.
53
54              Requesting info about an object will also notify you of changes.
55

WORKING WITH REMOTES

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

NODE MANAGEMENT

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

LINK MANAGEMENT

99       create-link node-id port-id node-id port-id [properties...]
100              Create a link between 2 nodes and ports.
101
102              Port ids can be -1 to automatically select an available port.
103
104              Properties are key=value pairs separated by whitespace.
105
106              This command returns a link variable.
107
108       destroy-link link-var
109              Destroy a link.
110

EXAMPLES

AUTHORS

113       The                PipeWire                Developers                <‐
114       https://gitlab.freedesktop.org/pipewire/pipewire/issues>;  PipeWire  is
115       available from https://pipewire.org
116