CLI Reference
Flags
| Flag | Default | Description |
|---|---|---|
--port | 9222 | CDP WebSocket server port |
--binary | auto-detect | Path to Firefox, Vulpine, or legacy Camoufox binary |
--headless | false | Run browser in headless mode |
--profile | — | Firefox profile directory |
--backend | juggler | Backend protocol: juggler or bidi |
--bidi-url | — | Connect to an existing BiDi WebSocket endpoint instead of launching Firefox |
--bidi-port | 9223 | Port for BiDi WebSocket when auto-launching Firefox with --backend bidi |
Examples
Basic usage with Vulpine browser
foxbridge --binary /path/to/vulpine --port 9222Headless mode
foxbridge --binary /path/to/vulpine --headless --port 9222BiDi backend with auto-launch
foxbridge --backend bidi --binary /usr/bin/firefox --port 9222Firefox is launched with --remote-debugging-port and foxbridge connects to the BiDi WebSocket automatically.
BiDi backend connecting to existing browser
foxbridge --backend bidi --bidi-url ws://localhost:9223/session --port 9222Custom profile directory
foxbridge --binary /path/to/vulpine --profile /tmp/foxbridge-profile --port 9222HTTP Endpoints
| Endpoint | Description |
|---|---|
GET /json/version | Browser version info + WebSocket URL |
GET /json/list | Active page targets with WebSocket URLs |
GET /json | Alias for /json/list |
WS /devtools/browser/ | Main CDP WebSocket connection |
WS / | Convenience alias for WebSocket |
Binary Detection
If --binary is not specified, foxbridge searches for Vulpine, Firefox, and legacy Camoufox names in this order:
./vulpine,./camoufox, or./firefox(current directory)- common VulpineOS and legacy Camoufox install paths
- System PATH (
which vulpine,which firefox,which camoufox)
Testing
# Run all tests with race detector
go test -race ./...
# Build only
go build ./...CI runs automatically via GitHub Actions on every push to main.
See also
- Foxbridge Quick Start — get started with foxbridge
- Getting Started — install and launch your first VulpineOS agent
Last updated on