Configuration

CLI Reference


pieeg-server [OPTIONS] [COMMAND]

Command	Description
`doctor`	Diagnose hardware, software, and configuration
`record FILE`	Record EEG to CSV (standalone, no server)
`monitor`	Live terminal display (standalone, no server)

Flag	Default	Description
`--ble-name NAME`	`EAREEG`	BLE advertised device name
`--ble-address ADDR`	—	BLE MAC address — skip scan, connect directly

BLE options only apply when --device ironbci8 is selected. Install the ironbci extra for Bluetooth support: pip install pieeg-server[ironbci].

Flag	Default	Description
`--record FILE`	—	Record to CSV while streaming
`--record-duration SEC`	—	Stop recording after N seconds

Flag	Default	Description
`--monitor`	—	Show terminal monitor alongside server
`--mock`	—	Synthetic EEG (no hardware needed)
`--no-webhooks`	—	Disable webhooks
`--osc`	—	Enable VRChat OSC bridge
`--osc-host HOST`	`127.0.0.1`	VRChat receiver
`--osc-port PORT`	`9000`	VRChat OSC port
`--osc-mode MODE`	`both`	`chatbox`, `parameters`, or `both`
`--osc-interval SEC`	`0.25`	OSC update rate
`--lsl`	—	Enable Lab Streaming Layer outlet
`--lsl-name NAME`	`PiEEG`	LSL stream name
`-v, --verbose`	—	Debug logging

The install script creates a systemd service that auto-starts on boot:


sudo systemctl status pieeg-server
sudo systemctl restart pieeg-server
journalctl -u pieeg-server -f

The systemd service runs with whatever flags were set during installation. Edit /etc/systemd/system/pieeg-server.service to change runtime options.

PiEEG Server has minimal dependencies:

Package	Version	Purpose
`websockets`	≥12.0	WebSocket streaming
`scipy`	≥1.10	Butterworth filter
`rich`	≥13.0	Terminal UI / monitor
`bleak`	≥0.21	Bluetooth LE (IronBCI only, optional)