Skip to content
akari v0.5.0 docs Log in

akari user guide

Reading this as an agent? The whole guide is also served as a single plain-text file at /llms-full.txt, so you can ingest every chapter in one fetch instead of crawling pages. A machine-readable index of the chapters is at /llms.txt, and any page is available as raw Markdown by appending .md to its URL.

You run one server (backed by Postgres) and point many thin clients at it, one per machine. The client discovers the session logs Claude Code, Codex, and pi leave on disk, resolves each session's working directory to a canonical git remote, and streams the raw bytes to the server with a resumable, append-only protocol. The server stores those bytes losslessly, parses them into a normalized projection (messages, tool calls, token usage, cost from a compiled-in rate table), and serves a web UI and a read-only MCP endpoint over it. Projects are keyed by git remote, so the same repository across worktrees and machines collapses into one. Because the client keeps no derived state, a parser improvement reaches old sessions by re-parsing on the server, with nothing re-uploaded. Everyone signed in sees every session; you publish one to share it with a logged-out viewer.

In a hurry: get your sessions flowing

If your goal is "get my agent sessions into an akari server my team already runs," here is the whole path, each step linked to its detail:

  1. Install the client. Getting started.
  2. Mint an ingest token on the server's account page and run akari login --server <url> --token <token>. Getting started.
  3. Push once, then keep pushing. akari sync uploads everything new; akari watch (or akari daemon start) keeps it flowing. Getting started.
  4. Read them. Open the server in a browser, or connect a coding agent over MCP.

No server yet? Self-hosting stands one up with a single docker compose up.

Read in order

The chapters build on each other.

  1. Introduction: the problem akari solves, the core model (raw bytes in, parsing on the server, keyed by git remote), and what akari is and is not.
  2. Getting started: install the client, mint an ingest token, and push your first sessions.
  3. The client: the akari CLI in depth. login, sync, watch, and the daemon; how it discovers sessions on disk; and the resumable, append-only upload.
  4. The web UI: reading your history. The overview and its trailing windows, the Insights quality surface, the session feed with search and filters, projects, and the transcript view with its tool bodies and live updates.
  5. Accounts and sharing: registration and invites, the three token scopes (ingest, read, full), session visibility, and publishing a session or your usage overview.
  6. Agent access: point a coding agent at your history through the read-only Model Context Protocol endpoint. The connect flow and the full tool catalog.
  7. Self-hosting: run the server. Docker Compose, configuration, the database, the first admin account, and reparse.
  8. Glossary: the terms the guide uses (sessions, projects, the fleet, transcripts, tokens and cost, content-addressed storage, reparse), defined for reference.

Good to know

A few constraints shape everything that follows:

  • The client runs anywhere; the server is Linux-only. Push from macOS, Windows, or Linux; host the server on Linux (a container or a systemd service).
  • Supported agents are Claude Code, Codex, and pi. The client reads the session logs each leaves in its standard location.
  • Authorization is deliberately flat. Signed in means you see every session. There is no private-to-one-user state; sharing is a matter of publishing, not of per-user walls. Accounts and sharing covers the full model.
  • A session that did not run in a git repository is still kept, but keyed to a local folder rather than a shared project. Glossary explains how that resolution works.

Next: Introduction -> the problem akari solves and the core model.