Documentation hub for the Nous AI framework. For the full, searchable API reference, see hexdocs.pm/nous.
🚀 Quick Start
- Getting Started — setup and first steps.
- Hello World — minimal example to verify your install.
📖 Guides
All guides live in guides/ — a categorized index covering core features, orchestration & multi-agent, providers & backends, and operations. Highlights:
- Tool Development · Structured Output · Skills · Hooks
- Memory · Knowledge Base · Evaluation
- Teams · Decisions · Deep Research · Workflows
- Providers Overview · Fallback · HTTP Backends
- Permissions & Guardrails · Observability
- LiveView Integration · Best Practices · Troubleshooting · Migration
📚 Examples
- Examples directory — the numbered walkthroughs plus
providers/,memory/,advanced/,workflow/, andeval/.
🔧 Architecture & Design
- LLM Council Design — architecture decisions and patterns.
- Benchmarks — performance notes (e.g. HTTP backends).
Where to start
- New users → Getting Started, then the numbered examples, then a focused guide.
- Building tools → Tool Development.
- Production deployment → Best Practices + Permissions & Guardrails + Observability.
- API reference → hexdocs.pm/nous.
External Resources
- GitHub: https://github.com/nyo16/nous
- Hex Package: https://hex.pm/packages/nous
- API Docs: https://hexdocs.pm/nous
- Community: GitHub Discussions and Issues