docs / cli

CLI Reference

The standalone command-line launcher. Start a server, generate tokens, and open the web client.

cli/src/index.ts

Usage

terminal
# With npx (no install)
npx @walkie-talkie/cli@latest

# Or install globally
npm install -g @walkie-talkie/cli
walkie-talkie

Options

FlagDescriptionDefault
-p, --port=<number>Port to listen on3456
-d, --dir=<path>Working directory for spawned terminalsCurrent directory
-f, --forceKill any existing process on the port before startingfalse
-o, --openOpen the web client in your default browserfalse
-h, --helpShow help message-
-v, --versionPrint 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 --open

Output

When the server starts, the CLI displays:

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>