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

DESCRIPTION

12       Interact with a PipeWire instance.
13
14       When a command is given, pw-cli(1) will execute the command and exit
15
16       When  no command is given, pw-cli(1) starts an interactive session with
17       the default pipewire instance pipewire-0.
18
19       Connections to  other,  remote  instances  can  be  made.  The  current
20       instance  name is displayed at the prompt. Some commands operate on the
21       current instance and some on the local instance.
22
23       Use the 'help' command to list the available commands.
24

GENERAL COMMANDS

26       help   Show a quick help on the commands available.
27

MODULE MANAGEMENT

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

OBJECT INTROSPECTION

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

WORKING WITH REMOTES

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

NODE MANAGEMENT

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

LINK MANAGEMENT

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

EXAMPLES

AUTHORS

110       The        PipeWire        Developers         <https://gitlab.freedesk‐
111       top.org/pipewire/pipewire/issues>;    PipeWire    is   available   from
112       http://pipewire.org
113