Getting started
Gaia runs locally and talks to you over Telegram, WhatsApp, or a terminal chat. You need a model API key (Gemini by default; OpenAI / ChatGPT also supported).
Install
Section titled “Install”curl -fsSL https://gaia-agent.com/install.sh | bashOne line: installs a self-contained gaia (every feature), links the gaia command, and walks you
through gaia setup (pick a model + connectors). macOS + Linux (Windows: use WSL). Details +
update/uninstall: Guides → Install. Prefer source? See From source.
Add a model key
Section titled “Add a model key”If you skipped setup, point gaia at a provider — secrets live in ~/.gaia/.env:
echo "GEMINI_API_KEY=your-key" >> ~/.gaia/.envPrefer OpenAI or your ChatGPT subscription? Run gaia model to pick a provider and sign in with
ChatGPT, or see Reference → Config for the llm block.
First chat (terminal)
Section titled “First chat (terminal)”gaiaThis opens an inline chat. Ask it to do something — “write me a haiku about the sea”, “add a
task to buy milk”, “run echo hi”. Gaia answers simple things itself and forges a soul for
anything a specialist should handle.
Connect a channel
Section titled “Connect a channel”To reach gaia from your phone, connect Telegram or WhatsApp, then run it as a background daemon:
gaia connect # interactive setup (Telegram token / WhatsApp QR)gaia start # run in the backgroundgaia status # check it's upThen DM gaia — your first message makes you admin. See Guides → Connectors.
From source
Section titled “From source”For development (uses uv):
git clone https://github.com/Sho0pi/gaia.git && cd gaiauv sync --all-extras --all-groupsecho "GEMINI_API_KEY=your-key" >> ~/.gaia/.envuv run gaiaNext steps
Section titled “Next steps”- Concepts → Missions — how souls and the task board work.
- Concepts → Memory — what gaia remembers, and how.
- Reference → CLI — every
gaiacommand. - Reference → Commands — the in-chat slash commands.