ModelSwap ModelSwap User Manual English中文
☰ Chapters

2. Install & Start

Recommended: the desktop app — a native GUI with the browser extension built in, ready out of the box; pick the CLI if you live in the terminal. Both share the same data directory ~/.modelswap — pick one.

2.1 Install the desktop app (macOS only, so far)

The desktop app currently supports macOS only (Apple Silicon + Intel). On Windows / Linux, install the CLI instead — see 2.2.

Download the dmg for your Mac from the GitHub release, drag ModelSwap into Applications, and open it:

Version Download SHA-256
Apple Silicon (M1/M2/M3/M4+) ModelSwap-1.0.57-arm64.dmg sha256
Intel ModelSwap-1.0.57-x64.dmg sha256

Newer versions: all releases. Once installed, the desktop app updates itself (see 2.3), so the dmg mostly matters for the first install.

macOS blocks the first launch?

If you get a "can't be opened" warning (wording varies — "App is damaged", "unidentified developer") — the app is fine, macOS just hasn't verified it yet. Allow it once:

  1. Open System Settings → Privacy & Security
  2. Click Open Anyway at the bottom

On launch the app is ready to use: it starts its own server (http://127.0.0.1:3780) and shows the console window; the browser extension lives inside it too (Settings → Browser Plugins → Open extension folder).

💡 The browser extension auto-detects ModelSwap's port (tries 3780 and upward), so you normally don't need to care about ports.

2.2 Install the CLI

Two ways to get the CLI:

The CLI includes the web console and the agent skill, and works on all three platforms. modelswap web defaults to port 3780 and auto-increments if it's taken; use -p for a custom port and -o to open the browser on start.

2.3 Update: CLI vs desktop

CLI (npm installs):

modelswap upgrade          # upgrade to the latest version

Desktop app: updates are checked on start and refreshed periodically while it runs. When a new version is available, a download icon appears at the upper left of the window — hover it for release notes, click to download, and the app installs and relaunches automatically (no separate "restart to install" step). Manual checks: app menu → Check for updates…, or Settings → About & Diagnostics → Check for updates.

Install the desktop app at /Applications/ModelSwap.app; automatic updates safely replace that copy. If an update fails, the upper-left icon stays so you can retry.

2.4 Uninstall

⚠️ The CLI and the desktop app share ~/.modelswap (vault, provider configs, snapshots) — deleting it also wipes the desktop app's data. Removing just one form: leave ~/.modelswap alone.

ModelSwap runs no daemon and never sits in the request path: it writes your config and exits — your agent talks to the model provider directly. Agent configs keep working after uninstall.

All set? Spend ten minutes on the Quick Start to make your first model switch. If anything went wrong during install, check the FAQ.