CLI Reference

Run wayscriber --help for the full list. Key options:

• --daemon, -d: run as background daemon
• --daemon-toggle: ask a running daemon to show/hide the overlay
• --active, -a: start active (one shot overlay)
• --mode <MODE>: initial board id (transparent, whiteboard, blackboard, or a custom id)
• --no-tray: disable system tray in daemon mode
• --clear-session: delete persisted session data
• --session-info: show session paths and status
• --session-file <PATH>: use a named session file instead of the configured default session
• --freeze: start with frozen background
• --exit-after-capture: exit after capture completes
• --no-exit-after-capture: keep overlay open after capture
• --resume-session: force session resume on
• --no-resume-session: force session resume off
• --light-toggle: compositor/global shortcut command for light passthrough on/off
• --light-draw-toggle: compositor/global shortcut command for sticky drawing in light mode
• --light-draw-on / --light-draw-off: press/release commands for draw-while-held light mode
• --about: show the About window
• --language <CODE>: choose an interface language for this invocation (auto, en, or zh-CN); applies to --active, --freeze, --daemon and --about
• --list-languages: list interface languages and report the configured and effective choice, including which setting selected it, then exit
• --check-update: ask wayscriber.com whether a newer release exists (nothing is installed — see Updating)
• --help: show help
• --version: show version

Interface language

wayscriber --list-languages
wayscriber --active --language zh-CN
wayscriber --daemon --language en

--language overrides WAYSCRIBER_LANGUAGE and [ui] language without changing the config file. auto follows the desktop locale. A daemon started with the flag passes it to its overlays and About windows, but not to the configurator. The flag cannot change a daemon that is already running. Use the configurator’s Language row to preview and save a language there.

Named session examples

wayscriber --active --session-file ~/Documents/lecture-04.wayscriber-session
wayscriber --freeze --session-file ~/Documents/lecture-04.wayscriber-session
wayscriber --daemon --session-file ~/Documents/default-work.wayscriber-session
wayscriber --daemon-toggle --session-file ~/Documents/meeting.wayscriber-session
wayscriber --session-info --session-file ~/Documents/lecture-04.wayscriber-session
wayscriber --clear-session --session-file ~/Documents/lecture-04.wayscriber-session

--session-file uses exactly that file, implies persistence for the run, and conflicts with --no-resume-session. Open/Save As flows require an existing parent directory. --session-info and --clear-session can still inspect or clean up stale paths.

If the daemon overlay is already visible with one named session, hide it before toggling to a different named session target.

See Sessions and Session Manager for overlay and configurator workflows.