Akno documentation
The root README is the short introduction. These guides explain the workflows and design in more depth without making every reader carry the complete implementation history.
Start here
- Getting started — install Akno, choose a setup, index, and run the first recall.
- The memory lifecycle — see what humans, agents, and the dream cycle do to the files.
- Core concepts — understand pages, documents, roles, rules, citations, and result states.
- Reading memory or Writing and ingestion — follow the workflow you need.
- The dream cycle — understand maintenance before enabling scheduled writes.
Reference and internals
- Configuration — config layers, secrets, models, profiles, and folder rules.
- Command reference — purpose, write behavior, and model needs for every command.
- How Akno works — indexing, retrieval, mutation, service, and recovery architecture.
- Operations — services, schedules, diagnostics, privacy, recovery, and platform constraints.
- Benchmarks — reproducible quality gates and current qualified-model evidence.
- Limitations — current capability boundaries and deliberate non-goals.
Common paths
| Goal | Read |
|---|---|
| Understand everyday behavior | Memory lifecycle → Core concepts |
| Try Akno safely | Getting started → Memory lifecycle |
| Connect an agent host | Reading memory: automatic context → Operations |
| Import existing files | Writing and ingestion → Core concepts |
| Enable autonomous maintenance | Memory lifecycle → Dream cycle |
| Diagnose missing or slow behavior | Operations → Benchmarks |
| Change Akno itself | CONTRIBUTING.md and AGENTS.md |