CLI Reference
The standalone command-line launcher. Start a server, generate tokens, and open the web client.
cli/src/index.tsUsage
terminal
# With npx (no install)
npx @walkie-talkie/cli@latest
# Or install globally
npm install -g @walkie-talkie/cli
walkie-talkieOptions
| Flag | Description | Default |
|---|---|---|
-p, --port=<number> | Port to listen on | 3456 |
-d, --dir=<path> | Working directory for spawned terminals | Current directory |
-f, --force | Kill any existing process on the port before starting | false |
-o, --open | Open the web client in your default browser | false |
-h, --help | Show help message | - |
-v, --version | Print version | - |
Examples
terminal
# Start on a custom port and auto-open
walkie-talkie -p 8080 --open
# Force kill existing process on port 3456
walkie-talkie --force
# Set working directory to a specific project
walkie-talkie -d ~/projects/my-app --openOutput
When the server starts, the CLI displays:
- An ASCII QR code you can scan from a mobile device
- A URL with the token embedded (e.g.
https://demo.walkie-talkie.dev?server=...&token=...) - The raw token value for manual entry
- Server address and port
Token Refresh
Tokens expire after 5 minutes and are single-use. To generate a new token without restarting the server:
terminal
# On macOS/Linux — send SIGUSR1 to the server process
kill -USR1 $(pgrep -f walkie-talkie)Port Conflicts
If something is already listening on the port, the CLI will detect it and offer the --force flag. With --force, it runs:
# macOS/Linux
lsof -ti:<port> | xargs kill -9
# Windows
taskkill /F /PID <pid>