User Guide

Installation & Setup

Download, install, and set up the AssistMe Desktop App on macOS, Windows, or Linux.

Download

Visit the Downloads page to get the latest installer for your platform. All releases are also available on the GitHub Releases page.

PlatformFormatNotes
macOS (Intel)DMGFor Intel-based Macs
macOS (Apple Silicon)DMGFor M1/M2/M3/M4 Macs
Windows.exe InstallerNSIS installer, x64
LinuxAppImageUniversal, runs on most distros
Linux (Debian/Ubuntu).debFor apt-based distributions

Installation

macOS

  1. Open the downloaded .dmg file
  2. Drag AssistMe into the Applications folder
  3. Launch AssistMe from Applications
  4. If macOS shows a security warning ("app is from an unidentified developer"), go to System Settings → Privacy & Security and click Open Anyway

Windows

  1. Run the downloaded .exe installer
  2. Follow the NSIS installer wizard — choose your install location and shortcuts
  3. Launch AssistMe from the Start Menu or desktop shortcut

Linux

AppImage:

  1. Make the file executable: chmod +x AssistMe-*.AppImage
  2. Run: ./AssistMe-*.AppImage

Debian/Ubuntu (.deb):

  1. Install: sudo dpkg -i assistme_*.deb
  2. Launch from your application menu or run assistme in the terminal

First-Time Setup Wizard

When you launch the Desktop App for the first time, a Setup Wizard guides you through three steps:

Step 1: Node.js Installation

The Desktop App needs Node.js to run the AssistMe CLI agent locally. The wizard will:

  • Check if Node.js (v18+) is already available on your system
  • Download and install an embedded copy of Node.js to the app's data directory if needed — this does not affect your system-wide Node.js installation

You'll see a progress bar during the download. The embedded Node.js is installed to ~/.assistme-data/ and is used exclusively by the Desktop App.

If you already have Node.js 18+ installed system-wide, the wizard will detect it and skip this step.

Step 2: CLI Installation

The wizard installs the AssistMe CLI via npm:

npm install -g assistme

This gives the Desktop App the assistme command-line tool it needs to run agents locally. The progress indicator shows installation status in real-time.

Step 3: Authentication

Sign in with your AssistMe account:

  1. Enter your email address
  2. Enter your password
  3. Click Sign In

The app authenticates against Supabase and stores your session securely. You'll remain signed in across app restarts.

If you don't have an account yet, create one first on the web or mobile app.

After Setup

Once the wizard completes, the app:

  1. Initializes your stores — Loads conversations, skills, jobs, and other data from the cloud
  2. Shows the Onboarding tutorial (first time only) — A 4-step walkthrough of the desktop interface:
    • Sidebar navigation
    • Creating sessions
    • Submitting tasks
    • Skills and credentials
  3. Starts the Agent — The background CLI agent begins running automatically

You're now ready to use the Cowork Workspace to send your first task.

Auto-Updates

The Desktop App checks for updates automatically on startup. When a new version is available:

  1. A banner notification appears at the top: "Update X.X.X available"
  2. Click Download to start the background download — a progress bar shows download status
  3. When the download completes, click Restart to install and relaunch
  4. Or click Dismiss to install later — the update will apply the next time you quit and relaunch

Updates are distributed via GitHub Releases and downloaded securely.

Settings

Access Settings via Cmd/Ctrl + , or through the command palette.

Theme

OptionDescription
LightLight background with dark text
DarkDark background with light text
SystemAutomatically follow your OS theme setting

Your theme preference is saved locally and applies immediately when changed. The System option monitors OS theme changes in real-time — if you switch your OS from light to dark mode, the app follows instantly.

Sign Out

Click your email in the sidebar, then click Sign Out. A confirmation dialog appears before signing out. Your data remains on the server — signing back in restores everything.

Troubleshooting

Setup Wizard Stuck on Node.js Installation

  • Check your internet connection — Node.js needs to be downloaded
  • If behind a corporate proxy, configure your system proxy settings before launching
  • As a workaround, install Node.js 18+ manually and relaunch the app

Agent Won't Start

  • Ensure the CLI was installed successfully (Step 2 of Setup)
  • Check the Agent Control page for error logs
  • Try stopping and restarting the agent

Authentication Failed

  • Verify your email and password on the web dashboard first
  • Make sure your account email is verified
  • Check if you can sign in on the web — if not, reset your password

Next Steps