MirthSync CLI

Open-source version control for Mirth Connect and Open Integration Engine. Transform server configurations into Git-tracked files, enable CI/CD pipelines, and bring modern DevOps to healthcare integration.

View on GitHub Get Started
Star on GitHub Discuss npm Package
How It Works

Git-Based Version Control for Mirth Connect

MirthSync bridges the gap between Mirth Connect's database-centric architecture and modern DevOps workflows. It uses the REST API to extract channel configurations, serializing them to version-controlled files — then reverses the process for automated CI/CD deployments.

Pull

Extract channels, code templates, and configuration from Mirth Connect to local files.

Commit

Review changes in Git diff, commit to your repository with meaningful messages.

Push

Deploy configuration from Git back to Mirth Connect — any environment, any branch.

terminal 
mirthsync -s https://mirth.example.com -u admin pull
Pulling channels...
  ✓ ADT-A01-to-FHIR
  ✓ Lab-Orders-Outbound
  ✓ Radiology-Results-Inbound
Pulling code templates...
  ✓ FHIR-Helpers
  ✓ HL7-Utilities
Pull complete: 3 channels, 2 code templates

git add . && git commit -m "Update ADT channel mapping"
mirthsync -s https://mirth-staging.example.com push
Transformation

Your Mirth Connect Server, Now in Files

MirthSync transforms database-locked configurations into an organized, version-controllable file structure. Each channel becomes a folder with XML files you can edit, search, and track with Git.

Mirth Connect

Mirth Connect Administrator dashboard showing channel groups with status indicators — Lab Integration, ADT Feeds, and Imaging & DICOM channels
Configs locked in proprietary database
PULL PUSH
REST API

Git-Tracked Files

file structure 
mirthsync/
├── Channels/
│   ├── ADT-A01-to-FHIR/
│   │   ├── channel.xml
│   │   └── Source Connector/
│   ├── Lab-Orders-Outbound/
│   └── Radiology-Results/
├── CodeTemplates/
│   ├── FHIR-Helpers.xml
│   └── HL7-Utilities.xml
└── GlobalScripts/
    └── globalScripts.xml
Editable, searchable, version-controllable

Files = Universal Access

Once configs are files, every development tool works — Git, VS Code, grep, sed, CI/CD pipelines, and more.

Bidirectional Flow

Pull configs to files, edit with any tool or the Admin Console, then push changes back to any Mirth server.

API-Driven Architecture

Works through the Mirth Connect REST API — no database access needed. Compatible across versions.

Quick Start

Get Started in 3 Steps

Install MirthSync, pull your channels, and start version controlling your Mirth Connect environment.

Install MirthSync

Install globally via npm — or clone the repository from GitHub.

terminal 
npm install -g mirthsync
Installation Guide

Pull Your Channels

Extract channels and configurations from your Mirth Connect or OIE server to version-controlled files.

terminal 
mirthsync -s https://mirth.example.com pull
Pull complete: 3 channels, 2 code templates

Version Control with Git

Commit configurations to Git and enable version control workflows for your integration platform.

terminal 
git add .
git commit -m "Initial sync from production"
CLI Reference
Workflows

Mirth Connect DevOps Workflows

MirthSync adapts to your team's Mirth Connect workflow — from CI/CD pipelines to visual interfaces.

CI/CD Automation

Automate Mirth Connect deployments with GitHub Actions, Jenkins, or GitLab CI. Test channels before production and enable continuous deployment across environments.

Best for: DevOps teams, automated deployments

Version Control

Track every Mirth Connect configuration change with Git. Full commit history, blame tracking, and instant rollback — essential for HIPAA audit trails and regulatory compliance.

Best for: Audit trails, compliance, rollback

Admin Plugin

Access all MirthSync features directly from the Mirth Connect Administrator console — no command line needed. Compatible with both Mirth Connect and OIE.

Best for: GUI users, no terminal required

IDE Editing

Edit channels in VS Code with syntax highlighting, IntelliSense, and multi-cursor editing. Search across all channels and refactor with full IDE features.

Best for: Developers who want modern editing tools
Use Cases

Built for Healthcare Integration Teams

MirthSync serves the full spectrum of healthcare integration professionals.

DevOps Engineers

Integrate your integration platform into CI/CD pipelines with automated testing, deployment workflows, and GitOps practices.

  • Automated deployments via GitHub Actions, Jenkins, GitLab CI
  • Infrastructure as code for healthcare integration
  • Automated testing before production deployment
  • Environment promotion workflows (dev → staging → prod)
Ecosystem

The Complete MirthSync Suite

MirthSync CLI is the foundation — extend it with the Admin Plugin, VS Code Extension, and comprehensive documentation.

MirthSync Plugin

All-in-one Admin Console extension. Sync directly from the Mirth Connect Administrator with a visual interface.

MirthSync for VS Code

Edit Mirth Connect channels in VS Code with syntax highlighting, IntelliSense, and one-click sync commands.

Documentation

Installation guides, CLI reference, CI/CD setup, backup & recovery, and multi-environment workflows.

Start Version Controlling Your Mirth Connect Channels

MirthSync is free, open-source, and ready for production. Bring version control and CI/CD to your Mirth Connect environment.

View on GitHub Get Started