Installation

This guide covers installing all three Aelio components. After installation, pick your platform guide for stack-specific SDK integration.

Installation order

1. Prerequisites     → Node.js 20+, pnpm, LLM API key (optional)
2. Aelio Server      → Docker or local dev server
3. Convox SDK        → npm install @aelio/sdk (in your backend)
4. Chat Widget       → npm install @aelio/chat (in your frontend)
5. Local development → Boot everything and test
6. Verify            → Health checks and smoke tests

Quick install (all components)

# Clone and build Aelio
git clone https://github.com/aelio-dev/aelio.git && cd aelio
pnpm install && pnpm build

# Terminal 1 — Server
export AELIO_SDK_SECRET=change-me-in-production
pnpm --filter @aelio/server dev

# Terminal 2 — Your backend
npm install @aelio/sdk
# ... expose tools and aelio.listen()

# Terminal 3 — Your frontend
npm install @aelio/chat
# ... mountAelioChat() or script tag

Component install commands

Component	Install command	Runs in
Aelio Server	`docker pull aelio/server` or `pnpm --filter @aelio/server dev`	Your infra
Convox SDK (Node)	`npm install @aelio/sdk`	Your backend
Convox SDK (Python)	`pip install aelio-sdk`	Your backend
Chat Widget	`npm install @aelio/chat`	Your frontend