OS Manuals

/usr/bin/pw-cli

server and user space API to deal with multimedia pipelines

From pipewire 1.6.11-r2 (os), captured 2026-11-05 by running pw-cli --help (exit 0). permalink

/usr/bin/pw-cli [options] [command]
  -h, --help                            Show this help
      --version                         Show version
  -d, --daemon                          Start as daemon (Default false)
  -r, --remote                          Remote daemon name
  -m, --monitor                         Monitor activity

Available commands:
	help | h            	Show this help
	list-vars | lv      	List all variables
	load-module | lm    	Load a module. <module-name> [<module-arguments>]
	unload-module | um  	Unload a module. <module-var>
	connect | con       	Connect to a remote. [<remote-name>]
	disconnect | dis    	Disconnect from a remote. [<remote-var>]
	list-remotes | lr   	List connected remotes.
	switch-remote | sr  	Switch between current remotes. [<remote-var>]
	list-objects | ls   	List objects or current remote. [<interface>]
	info | i            	Get info about an object. <object-id>|all
	create-device | cd  	Create a device from a factory. <factory-name> [<properties>]
	create-node | cn    	Create a node from a factory. <factory-name> [<properties>]
	destroy | d         	Destroy a global object. <object-id>
	create-link | cl    	Create a link between nodes. <node-id> <port-id> <node-id> <port-id> [<properties>]
	export-node | en    	Export a local node to the current remote. <node-id> [remote-var]
	enum-params | e     	Enumerate params of an object <object-id> <param-id>
	set-param | s       	Set param of an object <object-id> <param-id> <param-json>
	permissions | sp    	Set permissions for a client <client-id> <object> <permission>
	get-permissions | gp	Get permissions of a client <client-id>
	send-command | c    	Send a command <object-id>
	quit | q            	Quit
Options (5)
OptionDescriptionSource
-h, --helpShow this helphelp
--versionShow versionhelp
-d, --daemonStart as daemon (Default false)help
-r, --remoteRemote daemon namehelp
-m, --monitorMonitor activityhelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.