9Remote Docs

Desktop App

Run 9Remote as a native, zero-friction desktop application on macOS, Windows and Linux.

What It Does

While the 9Remote CLI runs in your terminal, the 9Remote Desktop App wraps the host and web interface in a lightweight native wrapper built with Tauri. It lives quietly in your system tray, boots on startup, and eliminates the need to keep a terminal window open.

Key Features

System Tray & Menu Bar Integration

  • Zero Terminal Clutter: Runs entirely in the background from your macOS Menu Bar or Windows System Tray.
  • One-Click Controls:
    • View server connection status and tunnel health.
    • Click to display your permanent access QR code and key.
    • Toggle device auto-approval.
    • Open the local dashboard or web workspace instantly.
    • Gracefully restart or shut down the host.

Auto-Start on Boot

  • Configurable to launch automatically when you turn on your computer:
    • macOS: Native LaunchAgent daemon.
    • Windows: Windows Startup registry service.
  • Ensures your computer is always accessible remotely even after an unexpected reboot.

High-Performance Native Screen Capture

  • Direct integration with native OS capture APIs:
    • macOS: Native CoreGraphics / ScreenCaptureKit pipeline.
    • Windows: Desktop Duplication API (DXGI) with hardware-accelerated JPEG encoding via @julusian/jpeg-turbo.
  • Minimal CPU overhead and optimized battery consumption when streaming.

Installation & Setup

macOS

  1. Download the latest .dmg or .app from releases.
  2. Drag 9Remote to your Applications folder.
  3. On first launch, grant the required macOS permissions:
    • Screen Recording: Required for Remote Desktop streaming.
    • Accessibility: Required for remote mouse and keyboard control.
  4. The 9Remote icon will appear in your top menu bar.

Windows

  1. Download the .msi or .exe installer.
  2. Run the installer and follow the prompt instructions.
  3. If prompted by Windows Defender SmartScreen, click More info → Run anyway.
  4. Allow 9Remote through the Windows Firewall for local peer-to-peer WebRTC connections.
  5. The 9Remote tray icon will appear in the bottom-right taskbar.

Linux

  1. Download the .deb (x64/arm64) or .AppImage (arm64) from releases.
  2. Install the .deb with sudo apt install ./9Remote-linux-*.deb, or mark the AppImage executable (chmod +x) and run it.
  3. The 9Remote icon appears in your system tray.

CLI vs Desktop App Comparison

FeatureCLI (9remote / 9remote start)Native Desktop App
PlatformmacOS, Linux, WindowsmacOS, Windows, Linux
System TrayNoYes
Terminal WindowRequired (or via systemd/screen)None needed
Auto-StartManual setup (systemd/cron)One-click toggle in Settings
Remote TerminalFull PTY daemonFull PTY daemon
AI AgentsFull supportFull support

Next Steps