Installation

This guide walks through installing Max and its dependencies from source.

Prerequisites

Max uses Bun (v1.3.9 or later) as its runtime. Install it with:

curl -fsSL https://bun.sh/install | bash

See bun.sh for alternative installation methods.

The Max CLI uses a lightweight Rust proxy binary. Install Rust with:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

See rustup.rs for details.

Clone the repository and install dependencies:

git clone git@github.com:max-hq/max.git
cd max
bun install
bun run build

This compiles the TypeScript packages and the Rust proxy binary. The max entry point is at the repository root.

Verify it works:

./max --help

For convenience, add the repository root to your PATH so you can run max from anywhere:

export PATH="/path/to/max:$PATH"

Max supports tab completion for commands, flags, installations, entity types, and more. Generate the completion script for your shell:

max completion zsh > ~/.zsh/completions/_max

Make sure ~/.zsh/completions is in your fpath. If it isn’t, add this to your .zshrc before compinit:

fpath=(~/.zsh/completions $fpath)
autoload -Uz compinit && compinit

max completion bash > ~/.bashrc.d/max.bash
source ~/.bashrc.d/max.bash

max completion fish > ~/.config/fish/completions/max.fish

max completion pwsh > $PROFILE/../max-completion.ps1
Add-Content $PROFILE ". $PROFILE/../max-completion.ps1"

max completion nu | save max-completion.nu
source max-completion.nu

Restart your shell or source the config file for completions to take effect.

With Max installed, create your first workspace:

max init my-project
cd my-project

Add connectors so you have data sources to work with:

max install --collection git@github.com:max-hq/max-connectors.git

This clones the collection to ~/.max/collections/ and makes its connectors available to all workspaces.