Installation

Install the extension, connect to your Mirth server, and start syncing—all in under five minutes.

Prerequisites

Before installing the extension:

• Visual Studio Code 1.85.0+ — Download VS Code
• Java 8+ (JRE or JDK) — Required by the MirthSync CLI
• MirthSync CLI — The extension uses the CLI under the hood for sync operations
• Mirth Connect 4.5.2+ or OIE — A running Mirth server to connect to
• Mirth CLI — Ships with Mirth Connect / OIE, required for deploy, import/export, and server status commands

Install MirthSync CLI

The extension requires the MirthSync CLI. Install it globally via npm:

npm install -g @saga-it/mirthsync

Verify the installation:

mirthsync --version

Java Required

The MirthSync CLI is a Node.js wrapper around a Java application. Java 8 or higher must be installed. If Java is not found, mirthsync will display platform-specific installation instructions when you run it.

Already using MirthSync CLI?

If you already have mirthsync installed, you’re all set. The extension will detect it automatically, or you can specify a custom path in settings.

Install Mirth CLI

The Mirth CLI ships with Mirth Connect and Open Integration Engine installations. The extension uses it for channel deployment, import/export, and server status commands.

The extension auto-detects the Mirth CLI in these locations:

• $MIRTH_HOME/cli/ environment variable (recommended)
• Linux: /opt/mirth/cli/mirth-cli, /usr/local/mirth/cli/mirth-cli, /opt/mirthconnect/cli/mirth-cli
• macOS: /Applications/Mirth Connect/cli/mirth-cli, /opt/mirth/cli/mirth-cli
• Windows: C:\Program Files\Mirth Connect\cli\mirth-cli.bat, C:\Program Files (x86)\Mirth Connect\cli\mirth-cli.bat

If the Mirth CLI isn’t detected automatically, set the path in VS Code settings:

{
  "mirthsync.mirthcliPath": "/opt/mirth/cli/mirth-cli"
}

Remote Servers

The Mirth CLI connects to the Mirth server API, so it works with remote servers — it doesn’t need to be on the same machine as Mirth Connect. However, the CLI binary itself must be accessible on your local machine.

---

Installation

VS Code Marketplace (Recommended)

Best for: Most users | Requirements: Internet access

Option A: Install from VS Code

1. Open VS Code
2. Click the Extensions icon in the Activity Bar (or press Ctrl+Shift+X)
3. Search for “MirthSync”
4. Click Install on the extension by Saga IT LLC

Option B: Install via Command Line

code --install-extension SagaITLLC.mirthsync

Option C: Quick Open

Press Ctrl+P in VS Code and paste:

ext install SagaITLLC.mirthsync

VSIX File (Offline)

Best for: Air-gapped environments, restricted networks | Requirements: VSIX file

For environments without internet access, install from a .vsix package:

Step 1: Download the VSIX

On a machine with internet access, download the latest .vsix from:

• VS Code Marketplace (click Download Extension on the right side)
• GitHub Releases

Step 2: Transfer and Install

Transfer the .vsix file to the target machine, then install:

code --install-extension mirthsync-0.1.11.vsix

Or from within VS Code:

1. Open the Command Palette (Ctrl+Shift+P)
2. Run Extensions: Install from VSIX…
3. Browse to the .vsix file

---

First Connection Setup

After installation, set up your first Mirth server connection:

Step 1: Open the Command Palette

Press Ctrl+Shift+P and run:

MirthSync: Add Connection

Step 2: Enter Connection Details

Provide your Mirth server information:

• Connection name — A label for this connection (e.g., “Dev Server”, “Production”)
• Server URL — Your Mirth Connect API URL (e.g., https://mirth-server:8443/api)
• Username — Mirth Connect admin username
• Password — Stored securely via the VS Code Secrets API

Credential Security

Your password is stored using the VS Code Secrets API, which uses your operating system’s secure credential store (Keychain on macOS, Credential Manager on Windows, libsecret on Linux). Credentials never leave your machine or appear in configuration files.

Step 3: Test and Connect

1. In the Mirth Connections tree view (left sidebar), find your new connection
2. Right-click and select Test Connection to verify
3. Right-click and select Set as Active to activate it

You should see your connection status in the VS Code status bar.

Step 4: Pull Your First Configuration

With an active connection, pull your Mirth configurations:

• Command Palette: Ctrl+Shift+P → MirthSync: Pull All
• Tree View: Right-click a channel group → Pull

Your channel files will appear in the VS Code file explorer, ready to edit.

---

Verify Installation

After installation, confirm everything is working:

Check	How to Verify
Extension loaded	Mirth Connections and Mirth Channels tree views appear in the sidebar
Status bar active	MirthSync connection indicator visible in the bottom status bar
CLI detected	Run MirthSync: Pull All — no “CLI not found” errors
Mirth CLI detected	Run MirthSync: Deploy Channel — no “mirth-cli not found” errors
Connection works	MirthSync: Test Connection returns success

CLI Not Found?

If the extension can’t find the MirthSync CLI, set the path manually in VS Code settings:

{
  "mirthsync.mirthsyncPath": "/usr/local/bin/mirthsync"
}

Or find it with which mirthsync (Linux/macOS) or where mirthsync (Windows).