The tool provides a single CLI for common CryoSPARC administration tasks, including master/worker installation, lane management, user creation, and direct access to cryosparcm and cryosparcw commands.

Features

Install a complete CryoSPARC deployment
Install multiple versions of CryoSPARC
Install CryoSPARC master and worker nodes independently
Support x86_64 and aarch64 architectures
Create and manage CryoSPARC lanes
Install and remove lanes
Create CryoSPARC users
Run cryosparcm commands
Run cryosparcw commands
Automatic detection of available ports with findbaseport
Detection of running CryoSPARC instances with uports

Installation

Clone the repository and build the executable:

git clone <repository-url>
cd cryosparc-merlin

make build

Verify the installation:

cryosparc-merlin --help

To display the installed version:

cryosparc-merlin --version

Usage

The general command structure is:

cryosparc-merlin <command> [flags] [arguments]

Available top-level commands:

changeport
cryosparcm
cryosparcw
install
instances
lanes
user

Run the following to see the available commands and flags:

cryosparc-merlin --help

By default, CryoSPARC will be installed in $HOME/cryosparc. However, this can be changed with the -d/--cryosparc-path:

cryosparc-merlin install complete --license [LICENSE] --version 5.0.6 -d $HOME/cryosparc_v5.0.6

When using the cryosparc-merlin commands that will target this installation, add -d $HOME/cryosparc_v5.0.6 to the command. For example, to create and install all default lanes in this installation:

cryosparc-merlin lanes create default -d $HOME/cryosparc_v5.0.6

and then install all lanes created

cryosparc-merlin lanes install -d $HOME/cryosparc_v5.0.6 --all