Installation

Install the GAIA CLI tool using npm, pnpm, or bun to set up and manage your GAIA instance from the terminal.

Install the CLI

The GAIA CLI (@heygaia/cli) is a terminal-based tool for setting up, configuring, and managing GAIA instances.

Install globally with your package manager:

npm

npm install -g @heygaia/cli

Verify Installation

gaia --version
gaia --help

If gaia is not available immediately, open a new terminal session and run gaia --help again.

Requirements

• macOS, Linux, or Windows (WSL2 recommended)
• Node.js 20+ and one package manager (npm, pnpm, or bun)
• Docker installed and running
• Git installed

The CLI checks prerequisites during setup and guides you if something is missing.

Upgrading

Updating GAIA

Pull the latest changes from your GAIA repo directory:

cd /path/to/gaia
git pull

If the update includes dependency changes, run gaia setup afterwards.

Updating the CLI

npm

npm install -g @heygaia/cli

Uninstalling

To fully remove GAIA from your machine:

1. Stop all running services:

gaia stop

2. Delete the GAIA repository directory:

rm -rf /path/to/gaia

3. Remove CLI metadata:

rm -rf ~/.gaia

4. Uninstall the CLI:

npm

npm uninstall -g @heygaia/cli

Next Steps

Commands Reference

See all available CLI commands

First-Time Setup

Set up GAIA from scratch using the CLI wizard