Skip to content

installation.md

Latest commit

 

History

History
220 lines (152 loc) · 3.84 KB

installation.md

File metadata and controls

220 lines (152 loc) · 3.84 KB
Raw

Installation Guide

mise (Recommended)

mise is a polyglot tool version manager. Install aipm from GitHub releases:

# Install using ubi backend
mise use -g ubi:TrogonStack/aipm

# Verify installation
aipm --version

Note: Requires mise >= 2024.1.0 with ubi backend support.

Install specific version

mise use -g ubi:TrogonStack/aipm@0.4.0

Update

mise upgrade aipm

Pre-built Binaries

Download pre-built executables from the releases page.

macOS

# Apple Silicon
curl -fsSL https://github.com/TrogonStack/aipm/releases/latest/download/aipm-darwin-arm64 -o aipm
chmod +x aipm
sudo mv aipm /usr/local/bin/

# Intel
curl -fsSL https://github.com/TrogonStack/aipm/releases/latest/download/aipm-darwin-x64 -o aipm
chmod +x aipm
sudo mv aipm /usr/local/bin/

# Verify installation
aipm --version

Linux

# x64
curl -fsSL https://github.com/TrogonStack/aipm/releases/latest/download/aipm-linux-x64 -o aipm
chmod +x aipm
sudo mv aipm /usr/local/bin/

# ARM64
curl -fsSL https://github.com/TrogonStack/aipm/releases/latest/download/aipm-linux-arm64 -o aipm
chmod +x aipm
sudo mv aipm /usr/local/bin/

# Verify installation
aipm --version

Windows

Download the latest aipm.exe from the releases page.

  1. Download aipm-windows-x64.exe
  2. Rename to aipm.exe
  3. Move to a directory in your PATH
  4. Verify: aipm --version

Build from Source

Prerequisites

  • Bun >= 1.2.0
  • Git

Steps

# Clone the repository
git clone https://github.com/TrogonStack/aipm.git
cd aipm

# Install dependencies
bun install

# Build executable for your platform
bun run build

# Install to system path (macOS/Linux)
sudo cp dist/aipm /usr/local/bin/

# Or create a symlink
sudo ln -s "$(pwd)/dist/aipm" /usr/local/bin/aipm

# Verify installation
aipm --version

Development Installation

For contributing or local development:

# Clone and install
git clone https://github.com/TrogonStack/aipm.git
cd aipm
bun install

# Run directly without building
bun run src/cli.ts {command}

# Or use watch mode
bun run dev

Verification

After installation, verify it works:

# Check version
aipm --version

# View help
aipm --help

# Initialize a project
cd your-project
aipm init

Troubleshooting

Command not found

Issue: aipm: command not found

Solutions:

  1. Ensure the binary is in a directory in your PATH
  2. Use full path: /usr/local/bin/aipm
  3. Add custom directory to PATH: 
    export PATH="$PATH:/path/to/aipm"

Permission denied

Issue: Permission denied when running the binary

Solution:

chmod +x /path/to/aipm

Binary won't run (macOS)

Issue: macOS blocks unsigned binary

Solution:

# Remove quarantine attribute
xattr -d com.apple.quarantine /path/to/aipm

# Or allow in System Settings > Security & Privacy

Updating

Pre-built Binary

Download the latest release and replace the old binary:

# Download new version (example for macOS Apple Silicon)
curl -fsSL https://github.com/TrogonStack/aipm/releases/latest/download/aipm-darwin-arm64 -o aipm
chmod +x aipm
sudo mv aipm /usr/local/bin/

From Source

cd aipm
git pull
bun install
bun run build
sudo cp dist/aipm-*/bin/aipm /usr/local/bin/

Uninstallation

# Remove the binary
sudo rm /usr/local/bin/aipm

# Clean up config (optional)
# Linux/macOS
rm -rf ~/.config/aipm
rm -rf ~/.cache/aipm
rm -rf .aipm  # In project directories

# Windows
rmdir /s /q "%APPDATA%\aipm"
rmdir /s /q "%LOCALAPPDATA%\aipm"
rmdir /s /q .aipm

Next Steps

After installation, see the README.md for usage instructions.