Command line

Take a snapshot of a remote screen

remora snapshot connects like a viewer, saves one full frame of the remote screen as a PNG, checks that remote input works by moving the pointer, and disconnects. Use it for scripts, monitoring, or to test a server.

bash
remora snapshot <id-or-address> <password> <out.png>
bash
remora snapshot 482913774 my-password screen.png

It prints what it did:

text
connected to Office-PC (windows) via peer-to-peer route
monitor 0: R24e 1920x1080 (primary)
keyframe 1920x1080 in 510 tiles
saved screen.png
remote pointer moved to (960, 540): input works

Environment variables

VariableUsed byEffect
REMORA_CONFIG_DIRappUse this folder for config.json instead of the default; run two copies side by side with different IDs
REMORA_SERVERsnapshotServer to use instead of the one in config.json
REMORA_P2P=0snapshotSkip peer-to-peer and use the relay, e.g. to test it
RUST_LOGapp and serverLog detail, for example RUST_LOG=debug

Two copies on one computer

Useful for development. Each copy gets its own ID:

powershell
$env:REMORA_CONFIG_DIR="$env:TEMP\remora-a"; cargo run -p remora
powershell
$env:REMORA_CONFIG_DIR="$env:TEMP\remora-b"; cargo run -p remora

Only one of them can take the direct-connection port 21118, so the other reports it as unavailable; that's expected.

Server options

bash
remora-server --help
OptionDefaultEffect
--bind <addr>0.0.0.0:21116Listen address for TCP and UDP. Repeat it to listen on several ports.

Debug builds only

These are compiled out of release builds and exist for screenshots and testing:

VariableEffect
REMORA_DEV_PAGE=contacts or settingsOpen that page on startup
REMORA_DEV_CONNECT=password@idStart a session on startup
REMORA_DEV_PIN=1 / REMORA_DEV_CHAT=1Pin that session's toolbar / open its chat