Getting Started with Phantasm

macOS and Linux

brew install indefiniteloop/tap/phantasm
# or
curl -fsSL https://raw.githubusercontent.com/indefiniteloop/phantasm-dist/main/scripts/install.sh | sh
phantasm --version

Use Homebrew if it is already part of your workflow. The shell installer remains the fallback path for Unix systems without Brew.

New to Homebrew?

Start by checking whether Homebrew is already installed.

brew --version

If that says brew: command not found, install Homebrew first:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Then reopen your terminal if prompted, run brew --version again, and install Phantasm with brew install indefiniteloop/tap/phantasm.

Windows

Use the published Windows release asset or run scripts/install.ps1 from the public distribution repo.

Turn it on for a project

cd /path/to/project
phantasm bootstrap

This creates the local .phantasm/ runtime for that project.

Add agent guidance

phantasm agents --add
phantasm agents --add --agent-file AGENTS.md --agent-file CLAUDE.md

This adds a managed Phantasm instruction block to common agent files. Phantasm asks for confirmation before it writes the file and backs up existing files before changing them.

Inspect the generated config files

After bootstrap, review .phantasm/phantasm.toml and .phantasm/clients.toml using the configuration reference. It documents every current key, default, and limitation in the shipped runtime.

Inspect the full command surface

phantasm --help
phantasm agents --help
phantasm help bootstrap

The top-level help lists commands. Command-specific help shows the available options for each workflow.

Important limitation

The current binary does not yet expose a first-class end-user MCP serve command. Today the public setup flow is bootstrap, and the advanced runtime flow is handle-request.