Using the Command Line Client

PyRogue provides a command-line client entry point for quick access to the running tree:

python -m pyrogue --help

The CLI connects to a running server (typically ZmqServer) and supports common get/set/exec/monitor operations.

Connecting To A Server

By default, the CLI connects to localhost:9099. Use --server to select another endpoint:

python -m pyrogue --server=localhost:9099

For GUI mode, --server may also be a comma-separated host list:

python -m pyrogue --server=localhost:9099,otherHost:9099 gui

Cmd	Path	Value	Operation
gui	NA	NA	Start the PyDM GUI
syslog	NA	NA	Dump current syslog and continue streaming updates
monitor	variable_path	NA	Display current Variable value and monitor updates
get	variable_path	NA	Read and display current Variable value
value	variable_path	NA	Display cached/shadow Variable value (no read)
set	variable_path	variable_value	Set Variable value
exec	command_path	command_arg	Execute Command with optional argument

Start GUI:

python -m pyrogue --server=localhost:9099 gui

Watch syslog:

python -m pyrogue --server=localhost:9099 syslog

Monitor a Variable:

python -m pyrogue --server=localhost:9099 monitor root.LocalTime

Read a Variable (forces read):

python -m pyrogue --server=localhost:9099 get root.RogueVersion

Read cached value only:

python -m pyrogue --server=localhost:9099 value root.AxiVersion.ScratchPad

Set a Variable:

python -m pyrogue --server=localhost:9099 set root.AxiVersion.ScratchPad 0x1000

Execute a Command:

python -m pyrogue --server=localhost:9099 exec root.SomeCommand 0x55