@yxcops/openlink-bridge
v1.0.0
Published
Local bridge between Codex and the OpenLink mobile app.
Readme
OpenLink Bridge
OpenLink Bridge connects the OpenLink iPhone app to Codex running on your Mac. It starts a local bridge process, prints a pairing QR code, and keeps trusted devices available for reconnect.
Install
npm install -g @yxcops/openlink-bridge
openlink upThe openlink up command starts the macOS bridge service and prints a QR code
or pairing code. Scan it once from the OpenLink iPhone app to trust this Mac.
Commands
openlink up
openlink status
openlink restart
openlink stop
openlink reset-pairing
openlink --versionOn macOS, openlink up starts a lightweight launchd service so the bridge can
continue running in the background. On other platforms, it runs the bridge in the
foreground.
Configuration
OpenLink Bridge can run with its built-in local relay for local pairing, or it can connect to a relay that you host yourself.
Common environment variables:
| Variable | Purpose |
| --- | --- |
| OPENLINK_RELAY | Relay URL used for pairing and reconnect, for example wss://relay.example.com/relay |
| OPENLINK_CODEX_ENDPOINT | Connect to an existing Codex app-server instead of starting one |
| OPENLINK_REFRESH_ENABLED | Enable Codex.app refresh after phone activity |
| OPENLINK_REFRESH_DEBOUNCE_MS | Debounce window for desktop refresh |
| OPENLINK_KEEP_MAC_AWAKE | Keep the Mac awake while the bridge is running |
| OPENLINK_DEVICE_STATE_DIR | Override where local pairing state is stored |
Legacy REMODEX_* environment variables are still accepted for compatibility,
but new OpenLink deployments should use OPENLINK_*.
Publishing With A Default Relay
By default, source checkouts and local packs do not embed a hosted relay. If a future release needs a packaged default relay, set these only at pack/publish time:
OPENLINK_PACKAGE_DEFAULT_RELAY_URL="wss://relay.example.com/relay" \
OPENLINK_PACKAGE_DEFAULT_PUSH_SERVICE_URL="https://relay.example.com" \
npm publish --access publicDo not commit generated private defaults or credentials.
Privacy And Security
The Codex runtime, git operations, and workspace access stay on the user's Mac. The iPhone is a paired remote control. After pairing, application messages are wrapped in an authenticated encrypted channel between the iPhone and the Mac bridge. A relay can route traffic, but it should not receive decrypted prompts, tool output, or Codex responses after the secure session is established.
The bridge stores trusted-device state locally on the Mac. Use:
openlink reset-pairingto clear the saved pairing and require a fresh QR scan.
Open Source Notice
OpenLink is an independent modified build based on the open-source Remodex
project. Remodex is licensed under the ISC License. The original copyright
notice and license terms are included in LICENSE and NOTICE.
OpenLink is not the original author's official app.
