Developer Guide
Project N.E.K.O. is an open-source AI companion platform with avatar rendering, realtime/text interaction, persistent memory, agent execution, and plugins. This site documents the current repository for contributors and integrators; it is not a product-pricing or provider-capability catalog.
Repository surfaces
- Python 3.11 FastAPI/Uvicorn services under
app/ - Conversation and persistent-memory domains under
main_logic/andmemory/ - Agent execution under
brain/and the agent server - Jinja/static pages plus one shared React chat implementation
- Vue plugin manager under
frontend/plugin-manager/ - Electron desktop distribution built from N.E.K.O.-PC plus this packaged backend
- Container deployment under
docker/
Evaluate N.E.K.O. before setup
| Question | Buyer guide |
|---|---|
| Is the app free, and what can AI services cost? | Cost and providers |
| Can it run completely offline? | Local and offline boundaries |
| Where can conversations and memory be sent? | Technical data flow and privacy controls |
| Which installation channel should I choose? | Steam, GitHub Releases, or source |
Start here
| Goal | Page |
|---|---|
| Check tools | Prerequisites |
| Prepare a checkout | Development Setup |
| Run N.E.K.O. | Quick Start |
| Navigate code | Project Structure |
| Understand services | Architecture |
| Build a plugin | Plugin Quick Start |
| Deploy | Deployment |
All Python examples use uv run. If a page conflicts with the same-revision entrypoint, loader, or workflow, current code is the source of truth; please report the documentation drift.