Skip to content

INSTALL.md

Latest commit

 

History

History
174 lines (125 loc) · 3.65 KB

INSTALL.md

File metadata and controls

174 lines (125 loc) · 3.65 KB
Raw

Installation

Quick Install

1. Binary

macOS (Homebrew — recommended):

brew install avivsinai/tap/amq

macOS/Linux (script):

curl -fsSL https://raw.githubusercontent.com/avivsinai/agent-message-queue/main/scripts/install.sh | bash

Installs to user-local directory (no sudo required):

  • $GOBIN if set
  • ~/.local/bin if exists
  • ~/go/bin if exists
  • ~/.local/bin (created if needed) The installer verifies release checksums when possible.

2. Skill

Install the skill to enable co-op mode guidance in Claude Code or Codex.

Method 1: skills (Recommended)

Using Vercel's skills CLI:

npx skills add avivsinai/agent-message-queue -g -y

Method 2: skild

Using skild registry:

# For Claude Code
npx skild install @avivsinai/amq-cli -t claude -y

# For Codex CLI
npx skild install @avivsinai/amq-cli -t codex -y

Or directly from GitHub:

npx skild install avivsinai/agent-message-queue -t claude -y
npx skild install avivsinai/agent-message-queue -t codex -y

Method 3: Skills Marketplace

Known Issue: Claude Code uses SSH to clone marketplace repos, which fails without SSH keys configured. See issue #14485. Use Method 1 or 2 instead.

Claude Code:

/plugin marketplace add avivsinai/skills-marketplace
/plugin install amq-cli@avivsinai-marketplace

Codex CLI (Codex chat command; not a shell command):

$skill-installer install https://github.com/avivsinai/agent-message-queue/tree/main/skills/amq-cli

Method 4: Manual (Always Works)

If npm tools fail (network issues, corporate firewalls, etc.):

Claude Code:

git clone https://github.com/avivsinai/agent-message-queue.git /tmp/amq
mkdir -p ~/.claude/skills
cp -r /tmp/amq/.claude/skills/amq-cli ~/.claude/skills/
rm -rf /tmp/amq

Codex CLI:

git clone https://github.com/avivsinai/agent-message-queue.git /tmp/amq
mkdir -p ~/.codex/skills
cp -r /tmp/amq/.agents/skills/amq-cli ~/.codex/skills/
rm -rf /tmp/amq

Restart your agent after installing.

Alternative Methods

Binary: Manual Download

Download from Releases:

Platform Asset
macOS (Apple Silicon) amq_*_darwin_arm64.tar.gz
macOS (Intel) amq_*_darwin_amd64.tar.gz
Linux (x86_64) amq_*_linux_amd64.tar.gz
Linux (ARM64) amq_*_linux_arm64.tar.gz
Windows amq_*_windows_amd64.zip (use in WSL) 
tar xzf amq_*.tar.gz
mkdir -p ~/.local/bin
mv amq ~/.local/bin/

Optionally verify checksums:

curl -fsSL https://github.com/avivsinai/agent-message-queue/releases/download/<TAG>/checksums.txt | grep amq_<VERSION>_<OS>_<ARCH>

Binary: Build from Source

Requires Go 1.25+:

git clone https://github.com/avivsinai/agent-message-queue.git
cd agent-message-queue
make build
mkdir -p ~/.local/bin
mv amq ~/.local/bin/

Binary: Install Script Options

# Specific version
curl -fsSL .../install.sh | VERSION=v0.8.0 bash

# Custom directory
curl -fsSL .../install.sh | INSTALL_DIR=~/bin bash

Verify

amq --version

Upgrading

Homebrew:

brew upgrade amq

Other installs:

amq upgrade

Or re-run the install script:

curl -fsSL https://raw.githubusercontent.com/avivsinai/agent-message-queue/main/scripts/install.sh | bash

Disabling Update Notifications

For CI or offline environments:

amq --no-update-check ...      # Per-command
export AMQ_NO_UPDATE_CHECK=1   # Global