@boardsketch/worker
@boardsketch/worker
The BoardSketch Worker is a user-owned, outbound-only npm process for WSL2 Ubuntu. It reuses the operator-selected Codex account through the repository's typed official app-server adapter and authenticates to BoardSketch Cloud with a locally generated P-256 device key.
npm install --global @boardsketch/worker@next
boardsketch-worker setup
boardsketch-worker doctor
boardsketch-worker codex status
boardsketch-worker codex login
boardsketch-worker pair
boardsketch-worker start
boardsketch-worker run --once
boardsketch-worker status
boardsketch-worker diagnostics
boardsketch-worker unpair
start remains attached to the terminal and opens no listener. run --once
sends one outbound presence update for schedulers and acceptance checks. Stop
start with Ctrl-C.
The exact configuration and state paths follow XDG conventions:
- configuration:
$XDG_CONFIG_HOME/boardsketch-worker/config.v1.json; - private state:
$XDG_STATE_HOME/boardsketch-worker/; - reserved data directory:
$XDG_DATA_HOME/boardsketch-worker/; - runtime scratch:
$XDG_RUNTIME_DIR/boardsketch-worker-$UID/.
Directories use mode 0700; configuration, registration, and private-key
files use mode 0600. The private key is never printed, included in
diagnostics, or passed to Codex.
The stable process exits are 0 for success, 2 when operator action is
required, 64 for invalid usage, and 70 for an unexpected internal failure.
Detailed, secret-free E_* codes accompany failures.