Skip to content

Installation

McAmner edited this page Jun 2, 2026 · 1 revision

Install and Update

mq-hal installs as a symlink to this checkout. The scripts do not install daemons, download models, or manage credentials.

Install

git clone https://github.com/MCamner/mq-hal.git ~/mq-hal
cd ~/mq-hal
./install.sh

By default this creates:

~/bin/mq-hal -> ~/mq-hal/bin/mq-hal

Use a different target directory with:

MQ_HAL_PREFIX=/usr/local/bin ./install.sh

PATH

Add this to ~/.zshrc if ~/bin is not already on PATH:

export PATH="$HOME/bin:$PATH"

Then open a new terminal or run:

source ~/.zshrc

Shell Completion Notes

There is no generated completion script yet. The stable top-level commands are listed with:

mq-hal tools

For zsh users, a lightweight helper is:

alias mqh='mq-hal'

Update

Preview the update command:

mq-hal update

Run the update:

mq-hal update --confirm

The bundled wrapper is equivalent:

./upgrade.sh

Config Check

Validate local configuration:

mq-hal config-check
mq-hal config-check --strict

--strict fails when configured repo paths do not exist.

Clean Reinstall

cd ~/mq-hal
./uninstall.sh
cd ..
mv mq-hal mq-hal.bak
git clone https://github.com/MCamner/mq-hal.git ~/mq-hal
cd ~/mq-hal
./install.sh
mq-hal config-check

Uninstall

cd ~/mq-hal
./uninstall.sh

The uninstall script only removes the symlink it owns. It refuses to remove a regular file at the target path.

Optional Homebrew Formula Plan

A future Homebrew formula should install the checkout files under Homebrew's prefix, link bin/mq-hal, run mq-hal config-check as a caveat, and avoid starting background services or downloading models.

Clone this wiki locally