Skip to content

Command Line Options

Alain De Carolis edited this page Oct 31, 2026 · 1 revision

Command-line options

Every setting can be passed as a flag; wfweb --help prints the list for your version. Flags override the settings file for that run and are not written back to it.

Connection

Flag Description Default
--serial-port <path> Serial device (/dev/ttyUSB0, COM5) first Icom port found
--civ <addr> CI-V address, hex (0x94) or decimal (148) auto-detect (USB only)
--manufacturer <id> 0 = Icom, 1 = Kenwood, 2 = Yaesu 0
--lan <ip> Connect over LAN/UDP (switches to LAN mode) USB
--lan-user <user> / --lan-pass <pass> LAN credentials, as set in the radio's network menu empty
--lan-control <port> / --lan-serial <port> / --lan-audio <port> The three UDP ports 50001 / 50002 / 50003
--no-autoconnect Start with the LAN session closed; connect from the web UI's Reconnect button. Also WFWEB_NO_AUTOCONNECT=1 autoconnect

Audio (server-side, USB rigs)

Flag Description Default
--audio-system <id> 0 = Qt, 1 = PortAudio, 2 = RtAudio Qt
--audio-device <name> Device by name prefix or case-insensitive substring ('USB Audio CODEC'); --audio-device list prints what wfweb sees a USB CODEC device if present

Audio between the radio and the browser is otherwise automatic: the browser plays RX audio and sends the mic back over the WebSocket, and the server moves it to and from the rig's codec (USB) or UDP audio channel (LAN).

Web server and interfaces

Flag Description Default
-p --port <port> Web UI port (HTTPS). The plain-HTTP REST API is on the next port up. 0 disables the web server 8080
-S --no-web No web server; run as a wfview-style rig server instead web on
-n --name <tag> Name shown in the top bar and the browser tab (handy with several instances) rig model
--rigctld-port <port> Enable the Hamlib rigctld TCP server (4532 is the conventional port) off
--rigctld-bind-all Bind rigctld to all interfaces. The protocol has no authentication: this exposes PTT to the whole LAN localhost only
--no-rigctld Disable rigctld even if the settings file enables it

Logbook

Flag Description Default
--logbook <file> The ADIF logbook the server keeps <data dir>/logbook.adi
--remote-log <host[:port]> Send every logged QSO to GridTracker, JTAlert, Log4OM or anything that listens for the WSJT-X UDP protocol off; port 2237 if omitted
--remote-log-decodes Also forward FT8/FT4 decodes to the remote logger
--no-remote-log Disable remote logging even if the settings file enables it

Process

Flag Description Default
-s --settings <file> Settings file; see Configuration File ~/.config/wfweb/wfweb.conf
-l --logfile <file> Log file /tmp/wfweb-*.log
-d --debug [file] Verbose log (CI-V traffic, cache, power and VFO decisions), optionally to a file; starts the terminal in the log view off
-b --background Run as a daemon (Linux, macOS) foreground
--no-tui Plain log on an interactive terminal instead of the status page. Also WFWEB_NO_TUI=1 status page
-c --clearconfig CONFIRM Reset every saved setting and exit
--packet-self-test Run the Direwolf encode/decode loopback for every baud rate and exit
-v --version, -? --help

Examples

USB Icom on a non-default CI-V address, named for a two-rig shack:

wfweb --civ 0x94 -n "7300 shack"

LAN IC-9700 with rigctld for WSJT-X on the same machine:

wfweb --lan 192.168.1.120 --lan-user admin --lan-pass secret --rigctld-port 4532

IC-7600 over USB on a Pi, with the codec pinned, logging to a file, as a service:

wfweb --civ 0x7A --serial-port /dev/ttyUSB0 --audio-system 1 --audio-device "USB Audio CODEC" -l /var/log/wfweb.log

Two radios, two instances, two settings files and two ports:

wfweb -s ~/wfweb-7300.ini -p 8080 -n IC-7300 --serial-port /dev/ttyUSB0
wfweb -s ~/wfweb-9700.ini -p 8090 -n IC-9700 --lan 192.168.1.120 --lan-user admin --lan-pass secret

Clone this wiki locally