Command Cheat Sheet

MirthSync Command Cheat Sheet

Quick reference for the most common MirthSync commands. Print this page for a handy desk reference.

---

Setup & Configuration

npm (Recommended)

First-time setup

# Install MirthSync globally
npm install -g mirthsync

# Create project directory
mkdir my-mirth-project && cd my-mirth-project

# Set password (avoids command-line exposure)
export MIRTHSYNC_PASSWORD="your-password"

# Initialize with first pull
mirthsync -s https://server:8443/api -u admin -t . pull

# Initialize Git repository
mirthsync -t . git init
mirthsync -t . git add
mirthsync -t . --commit-message "Initial commit" git commit

JAR

First-time setup

# Download MirthSync JAR
curl -L -o mirthsync.jar https://github.com/SagaHealthcareIT/mirthsync/releases/latest/download/mirthsync.jar

# Create project directory
mkdir my-mirth-project && cd my-mirth-project

# Set password (avoids command-line exposure)
export MIRTHSYNC_PASSWORD="your-password"

# Initialize with first pull
java -jar mirthsync.jar -s https://server:8443/api -u admin -t . pull

# Initialize Git repository
java -jar mirthsync.jar -t . git init
java -jar mirthsync.jar -t . git add
java -jar mirthsync.jar -t . --commit-message "Initial commit" git commit

Create an Alias

Add alias mirthsync="java -jar /path/to/mirthsync.jar" to your shell profile for shorter commands.

---

Daily Workflow

Pull & Push

Sync with server

# Pull latest from server
mirthsync -s https://server:8443/api -u admin -t . pull

# Push changes to server
mirthsync -s https://server:8443/api -u admin -t . push

# Push and deploy channels individually
mirthsync -s https://server:8443/api -u admin -t . -d push

# Push and deploy ALL channels at once
mirthsync -s https://server:8443/api -u admin -t . --deploy-all push

Git Operations

Version control

# Check status
mirthsync -t . git status

# View changes
mirthsync -t . git diff

# Stage and commit
mirthsync -t . git add
mirthsync -t . --commit-message "Your message" git commit

# Push to remote
mirthsync -t . git push

# Pull from remote
mirthsync -t . git pull

---

Branching

Feature branches

# List branches
mirthsync -t . git branch

# Switch to existing branch
mirthsync -t . git checkout main

Limited Branch Support

MirthSync’s embedded Git supports listing and switching to existing branches. For creating new branches, merging, or deleting branches, use native Git commands directly in your project directory.

---

Environment Management

Multiple environments

# Pull from dev environment
mirthsync -s https://mirth-dev:8443/api -u admin -t ./dev-config pull

# Pull from production environment
mirthsync -s https://mirth-prod:8443/api -u admin -t ./prod-config pull

# Push to staging environment
mirthsync -s https://mirth-staging:8443/api -u admin -t ./staging-config push

---

Common Options

Option	Short	Description
--server	-s	Server URL (https://host:8443/api)
--username	-u	Admin username
--target	-t	Local directory path (required)
--deploy	-d	Deploy changed channels individually
--deploy-all		Deploy all channels at once
--force	-f	Force overwrite
--ignore-cert-warnings	-i	Ignore SSL certificate warnings

---

Environment Variables

Secure password handling

# Set password (avoids command-line exposure)
export MIRTHSYNC_PASSWORD="your-password"

# Then run commands without password prompt
mirthsync -s https://server:8443/api -u admin -t . pull

---

Quick Tasks

Rollback to Previous Version

# View commit history (get commit hash from here)
mirthsync -t . git log

# Reset to specific commit (use full commit hash from git log)
mirthsync -t . git reset --hard abc123def456...

# Soft reset (keeps changes staged)
mirthsync -t . git reset --soft abc123def456...

# Reset staging area (unstage all)
mirthsync -t . git reset

Commit References

MirthSync’s git reset requires full commit hashes. Relative references like HEAD~1 are not supported. Use git log to find the commit hash you want to reset to.

Compare Environments

# Pull from both environments to different directories
mirthsync -s https://dev:8443/api -u admin -t ./dev-config pull
mirthsync -s https://prod:8443/api -u admin -t ./prod-config pull

# Compare with diff tool
diff -r ./dev-config ./prod-config

Backup Current State

# Quick backup with timestamp
mirthsync -s https://server:8443/api -u admin -t . pull
mirthsync -t . git add
mirthsync -t . --commit-message "Backup $(date +%Y-%m-%d)" git commit
mirthsync -t . git push

---

CI/CD Integration

GitHub Actions example

# In your workflow file
- name: Pull Mirth Config
  run: |
    curl -L -o mirthsync.jar https://github.com/SagaHealthcareIT/mirthsync/releases/latest/download/mirthsync.jar
    java -jar mirthsync.jar -s ${{ secrets.MIRTH_URL }} -u ${{ secrets.MIRTH_USER }} -t . pull
  env:
    MIRTHSYNC_PASSWORD: ${{ secrets.MIRTH_PASSWORD }}

# Deploy to production
- name: Push to Production
  run: java -jar mirthsync.jar -s ${{ secrets.PROD_URL }} -u ${{ secrets.MIRTH_USER }} -t . -d push
  env:
    MIRTHSYNC_PASSWORD: ${{ secrets.MIRTH_PASSWORD }}

Docker usage

# Run MirthSync in Docker
docker run -v $(pwd):/data sagait/mirthsync pull -s https://server:8443/api -u admin -t /data

---

Troubleshooting

Common fixes

# Connection refused - check URL format
mirthsync -s https://server:8443/api -u admin -t . pull  # Include /api

# SSL certificate errors
mirthsync -s https://server:8443/api -u admin -i -t . pull

# Authentication failed - check credentials
mirthsync -s https://server:8443/api -u admin -t . pull  # Will prompt for password

# Reset local changes (unstage all)
mirthsync -t . git reset

# Verbose output for debugging
mirthsync -s https://server:8443/api -u admin -v -t . pull

---

File Structure Reference

my-mirth-project/
├── Channels/
│   └── Group Name/
│       └── Channel Name/
│           ├── channel.xml
│           └── *.js (transformers)
├── CodeTemplates/
│   └── Library Name/
│       └── template.xml
├── GlobalScripts/
├── Resources/
└── ServerConfiguration/

---

Related Resources

• Full CLI Reference - Complete command documentation
• Installation Guide - Detailed setup instructions
• Glossary - Term definitions