Skip to content

User Manual

This manual covers the desktop and tray experience. For installation, start with the platform guide. For configuration details, use the settings reference.

The tray or menu-bar popover shows four rows:

Row What it means
OpenCode The managed server is starting, healthy, or unavailable
Tunnel The Cloudflare tunnel is connected, connecting, or disconnected
Proxy The local authenticated proxy is available
Keep awake Whether an idle-sleep inhibitor is currently held

A running cloudflared process alone does not mean connected. Cloud Link checks live tunnel readiness and surfaces the actual state.

Use the power control in the popover to connect or disconnect. On a terminal failure, the control is labeled Retry instead.

  • Connect starts the supervised runtime and opens the tunnel.
  • Disconnect stops the connection while keeping saved pairing state.
  • Retry re-runs startup after you fix the reported problem.

Transient failures retry automatically with capped backoff. Terminal failures, such as rejected tunnel credentials or invalid configuration, stop for explicit action.

Choose Open OpenCode to launch the managed OpenCode web UI in its own window. The window uses a short-lived, single-use pairing link against the loopback server. It does not use the remote browser password.

If the connector adopted an existing server without managed credentials, the action falls back to the plain loopback page.

Choose the browser access control to show:

  • the public URL;
  • username browser;
  • the generated password;
  • copy actions;
  • a regenerate action.

Hiding the panel does not disable browser access. Regenerate the password to invalidate existing browser logins. See Remote browser access.

Choose Pair device to generate a fresh QR code. Re-pairing preserves the installation identity but interrupts the current connection.

If the machine is no longer used with this account, choose Settings → Remove saved connection. The machine stays in the account, but the connector stops retrying until you pair again. See Pair with OpenCode Mobile.

Enable Settings → Startup → Start automatically on login to launch the connector quietly when you sign in. It is opt-in.

  • On macOS, the login item can restart the app after an unexpected exit. An explicit Quit stays stopped.
  • On Windows, the installer manages a per-user Run entry and removes it on uninstall.
  • On Linux, use the optional systemd user service instead of a desktop login item.

Settings → Power → Keep awake has three modes:

  • Off — default.
  • While agents active — hold an idle-sleep inhibitor during OpenCode work.
  • While remotely connected — hold it during authenticated remote traffic.

Keep awake on battery is off by default. The inhibitor prevents automatic idle sleep only. The display may still sleep, and explicit sleep or a closed lid is always honored.

  • Closing the window hides it. The connector keeps running.
  • Launching the app again focuses the existing instance instead of starting a second one.
  • Quit stops the runtime and waits for owned child processes to clean up.
  • After an unexpected exit, macOS can relaunch the app. If you explicitly quit, start it again.

Open Settings → Diagnostics to see recent lifecycle events. Logs are redacted and do not include credentials or request contents. Choose Refresh logs after reproducing a problem.

For a stuck connection, read the sanitized error in the popover first, fix the cause, then choose Retry. See Troubleshooting for the symptom table.

Cloud Link does not install an automatic updater. Download the current release and install it over the existing version. Pairing identity, settings, and exposed services survive a normal reinstall. See Releases and updates.

OpenCode Cloud Link is an independent project. It is not built by the OpenCode team and is not affiliated with them in any way. See thePrivacy Policy andTerms & Conditions.