Skip to content

Installation

Squish runs on macOS with Apple Silicon (M1–M5). Pick the install method that suits you.


brew install konjoai/squish/squish

Homebrew manages dependencies, creates the squish binary in your PATH, and makes upgrades easy:

brew upgrade squish

Option 2: pip

pip install squish-ai

Requires Python 3.10+ and installs the squish CLI entry point automatically. The PyPI distribution is squish-ai, but the installed module and CLI are both squish.

For a virtual environment (recommended):

python3 -m venv .venv && source .venv/bin/activate
pip install squish-ai

Option 3: curl installer

curl -sSL https://raw.githubusercontent.com/konjoai/squish/main/install.sh | bash

Review before running

Piping curl to bash executes arbitrary code. Review install.sh first.


Option 4: From source

git clone https://github.com/konjoai/squish
cd squish
pip install -e ".[dev]"

This also installs development extras (pytest, ruff, mypy, httpx).


Verify the installation

squish --version
squish --help

You should see version info and the command list.


Requirements

Requirement Version
macOS 13 Ventura or later
Apple Silicon M1 / M2 / M3 / M4 / M5
Python 3.10+
MLX ≥ 0.18
Free RAM ≥ 8 GB (16 GB+ recommended)
Free disk ≥ 5 GB per model

Uninstall

brew uninstall squish
brew untap konjoai/squish
pip uninstall squish-ai
pip uninstall squish-ai
rm -rf /path/to/squish