Installation
Installation
Install and configure the Aelio server, SDK, and chat widget.
This guide covers installing all three Aelio components and linking your pipeline YAML. 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. Aelio SDK → npm install @aelio/sdk (in your backend)
4. Pipeline YAML → Create and link your manifest (required)
5. Chat Widget → npm install @aelio/chat (in your frontend)
6. Local development → Boot everything and test
7. Verify → Health checks and smoke testsQuick 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 tagComponent install commands
| Component | Install command | Runs in |
|---|---|---|
| Aelio Server | docker pull aelio/server or pnpm --filter @aelio/server dev | Your infra |
| Aelio SDK (Node) | npm install @aelio/sdk | Your backend |
| Aelio SDK (Python) | pip install aelio-sdk | Your backend |
| Chat Widget | npm install @aelio/chat | Your frontend |
Pipeline YAML (required)
Every integration needs a pipeline YAML file. Your SDK backend loads it at startup and registers stages, attributes, and flows with Aelio.
See Pipeline YAML Manifest for how to create the file and wire it into your project.
Next: pick your platform
After installation, follow the detailed integration guide for your stack: