CLI Reference
Complete reference for all forkoff commands and options.
Quick install: npm install -g forkoff
forkoff pair
Generate a QR code to pair with the mobile app.
Options
| --timeout <seconds> | QR code expiration time (default: 300) |
| --port <number> | Local server port (default: 9876) |
Example
forkoff pair --timeout 600forkoff connect
Reconnect to a previously paired device.
Options
| --device <id> | Specific device ID to connect |
Example
forkoff connectforkoff disconnect
Unpair the current device.
Options
| --all | Unpair all devices |
| --device <id> | Unpair specific device |
Example
forkoff disconnect --allforkoff status
Show connection status and paired devices.
Options
| --json | Output in JSON format |
Example
forkoff status --jsonforkoff tools
Detect and configure AI tool integrations.
Options
| --install-hooks | Install integration hooks |
| --uninstall-hooks | Remove integration hooks |
| --list | List detected AI tools |
Example
forkoff tools --install-hooksforkoff config
View or modify configuration settings.
Options
| get <key> | Get a config value |
| set <key> <value> | Set a config value |
| --reset | Reset to defaults |
Example
forkoff config set notifications.sound trueConfiguration
ForkOff stores configuration in ~/.forkoff/config.json. You can edit this file directly or use the forkoff config command.
Available Settings
| Key | Default | Description |
|---|---|---|
| notifications.enabled | true | Enable push notifications |
| autoApprove.reads | true | Auto-approve file reads |
| autoApprove.safePaths | [] | Paths to auto-approve writes |
| server.port | 9876 | Local server port |
Security
ForkOff takes security seriously. Here's how we protect your code:
End-to-End Encryption
All communication between your devices is encrypted using TLS 1.3. Your code and commands never pass through our servers unencrypted.
Local-First Architecture
The CLI runs entirely on your machine. We only relay encrypted messages between your devices. We can't see your code.
No Account Required
Start using ForkOff without creating an account. Device pairing uses cryptographic keys, not passwords.
Troubleshooting
QR code won't scan
Make sure your phone and computer are on the same network. Try:
forkoff pair --port 9877Connection keeps dropping
Check your firewall settings. ForkOff needs port 9876 (or your configured port) open for local connections.
Claude integration not working
Reinstall the hooks and restart Claude Code:
forkoff tools --uninstall-hooksforkoff tools --install-hooks