Installation

Matchlock supports:

Quick install script

Use the installer script from this repository:

curl -fsSL https://raw.githubusercontent.com/jingkaihe/matchlock/main/scripts/install.sh | bash

To install a specific release:

curl -fsSL https://raw.githubusercontent.com/jingkaihe/matchlock/main/scripts/install.sh | bash -s -- --version 0.2.4

On macOS, pinned installs work once the Homebrew tap has been updated to that same release.

If you already have the repository checked out locally, you can also run:

./scripts/install.sh

The script detects the current OS and architecture:

on macOS, it installs via Homebrew and upgrades existing installs
on Linux, it downloads and installs the latest matching .deb or .rpm package from GitHub Releases

On Linux, the script currently supports:

After installation, verify the host with:

matchlock diagnose

If the host still needs administrative setup, run:

sudo matchlock setup linux

To enroll a specific local user explicitly, run:

sudo matchlock setup user <name>

brew tap jingkaihe/essentials
brew install matchlock

Download the matching release asset from GitHub Releases, then install it:

sudo dpkg -i ./matchlock_<version>_linux_amd64.deb
sudo apt-get install -f

For arm64 systems, use the linux_arm64.deb release asset instead.

Download the matching release asset from GitHub Releases, then install it:

sudo dnf install ./matchlock_<version>_linux_amd64.rpm

For arm64 systems, use the linux_arm64.rpm release asset instead.