Installation Guide

Quick Install Methods

Homebrew (macOS/Linux)

# Install
brew tap mkforge/homebrew-mkforge
brew install mkforge

# Update
brew upgrade mkforge

One-Line Install (Linux/macOS)

# Download and install to /usr/local/bin
curl -L https://mkforge.github.io/releases/latest/mkforge-$(uname -s | tr '[:upper:]' '[:lower:]')-$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/') -o mkforge && chmod +x mkforge && sudo mv mkforge /usr/local/bin/

PowerShell Install (Windows)

# Download and install
Invoke-WebRequest -Uri "https://mkforge.github.io/releases/latest/mkforge-windows-amd64.exe" -OutFile "mkforge.exe"

# Optional: Add to PATH for easier access
$env:Path += ";$pwd"

Direct Downloads

Note

Direct binary downloads are provided for advanced users or special cases. For most users, we recommend using the installation methods above.

Detecting your platform...

System Requirements

Operating Systems

• macOS (10.15 or later)
• Linux (kernel 2.6.23 or later)
• Windows 10/11

Architecture Support

• x86_64 (amd64)
• ARM64 (Apple Silicon, aarch64)

Verifying Downloads

Each release includes SHA-256 checksums for verification:

Linux/macOS

# Download checksum file
curl -O https://mkforge.github.io/releases/latest/checksums.txt

# Verify download (replace filename with your downloaded file)
sha256sum -c checksums.txt --ignore-missing

Windows (PowerShell)

# Download checksum file
Invoke-WebRequest -Uri https://mkforge.github.io/releases/latest/checksums.txt -OutFile checksums.txt

# Calculate file hash
$hash = Get-FileHash mkforge-windows-amd64.exe -Algorithm SHA256

# Compare with expected hash
Select-String -Path checksums.txt -Pattern $hash.Hash

All Releases

Loading releases...

Uninstallation

Homebrew (Recommended installation)

brew uninstall mkforge
brew untap mkforge/homebrew-mkforge

Manual Installation

# macOS/Linux
sudo rm /usr/local/bin/mkforge

# Windows PowerShell
Remove-Item mkforge.exe

Configuration Cleanup (Optional)

# Remove global config
rm -rf $HOME/.config/mkforge

# Remove local project configs
rm .mkforge.yaml

Getting Started After Install

1. Verify installation:

mkforge version

2. Generate your first project summary:

# Go to your project directory
cd your-project

# Create a project summary
mkforge context

3. Start using with AI tools:

• Share the generated context.md with ChatGPT or Claude
• Ask questions about your code
• Get more accurate, context-aware answers

Troubleshooting

Common Installation Issues

1. Permission Denied

# Fix permissions on macOS/Linux
sudo chmod +x /usr/local/bin/mkforge

2. Command Not Found

# Add to PATH on Windows (PowerShell)
$env:Path += ";C:\path\to\mkforge"

# Add to PATH on macOS/Linux
echo 'export PATH="/usr/local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

3. Version Mismatch

# Update to latest version
brew upgrade mkforge  # Homebrew
mkforge version      # Check current version

Need help? Check our documentation or visit our GitHub repository for support.