使用说明
Aurelius
Self-hosted knowledge graph memory for developers and AI agents.
Quick Start · MCP Tools · Search · Snapshot · Tasks · Finance · Sync · Graph UI · Changelog
Aurelius keeps projects, decisions, problems, solutions, tasks, reminders and personal finance in
one local SQLite knowledge graph, and serves it to Claude Code as an MCP server, to you as the au CLI, and to the
browser as a graph UI.
The Problem
Every AI session starts from zero. You re-explain your projects, your past decisions, your architecture. Tasks scatter across tools with no memory of what was done.
With Aurelius: memory_status → full project context. task_view → complete work history. memory_session → nothing lost between sessions.
Quick Start
Aurelius ships as a Claude Code plugin: seven au hook commands, skill cards and
the /pickup command, installed with two claude plugin commands instead of hand-edited
settings.json. The MCP server is registered separately, user-scope, by install.sh (claude mcp add -s user aurelius au mcp) — a plugin-bundled server would rename every tool to
mcp__plugin_aurelius_aurelius__*.
Clean machine (Linux, macOS)
git clone https://github.com/Blysspeak/aurelius && cd aurelius
cargo build --release
install -m 755 target/release/au target/release/aurelius ~/.local/bin/ # must be in PATH
au init
claude mcp add -s user aurelius au mcp # MCP server, user scope: tools stay mcp__aurelius__*
claude plugin marketplace add Blysspeak/aurelius # or a local clone path: claude plugin marketplace add .
claude plugin install aurelius@blysspeak -s user
Restart Claude Code. claude plugin list shows aurelius@blysspeak, and a fresh session gets the
skill index at start.
Existing machine (stood up by hand or by an older install.sh)
cd aurelius && git pull && ./install.sh
install.sh builds the binaries, installs the plugin, registers the MCP server user-scope with
claude mcp add -s user aurelius au mcp, and removes any legacy hook and mcpServers.aurelius
entries it previously wrote into ~/.claude/settings.json and ~/.claude.json — printing each
removed entry with its reason and leaving a .bak-<UTC date> copy next to each file it touches.
Migration keeps a canonical au mcp entry in ~/.claude.json and removes only the old
wrapper-path entry; re-running the whole script, including the MCP registration, is a no-op once
migrated. Use ./install.sh --migrate-only to run just the cleanup, without building anything or
registering the server.
Windows
git clone https://github.com/Blysspeak/aurelius; cd aurelius
cargo build --release
New-Item -ItemType Directory -Force "$env:USERPROFILE\.local\bin" | Out-Null
Copy-Item target\release\au.exe "$env:USERPROFILE\.local\bin\" # must be in PATH
au init
claude mcp add -s user aurelius au mcp
claude plugin marketplace add Blysspeak/aurelius
claude plugin install aurelius@blysspeak -s user
Git Bash and python3 are not required — every plugin hook runs au directly. If hooks were
previously added by hand, remove them from $env:USERPROFILE\.claude\settings.json (hooks whose
command matches aurelius-*.sh or au … --hook) — copy the file first. A mcpServers.aurelius
entry in $env:USERPROFILE\.claude.json is now the right place, when its command is au mcp;
only an entry pointing at the old wrapper script is stale — replace it with
claude mcp add -s user aurelius au mcp.
$ au --version
au 3.8.0 (0123456789ab)
$ aurelius --version # the MCP binary answers too, instead of holding stdin open
aurelius 3.8.0 (0123456789ab)
The parenthesis is the 12-character commit the binary was built from, with -dirty appended
when the tree had uncommitted changes and unknown for a build outside git — so an installed
binary can be traced back to its source.
Nothing is indexed behind your back: no au command and no memory_status call turns the
current directory into a project. A repository enters the graph only through an explicit
au reindex (or MCP memory_index); install.sh runs it once, for the aurelius checkout itself.
Features
- Knowledge graph over MCP — 52 tools for memory, tasks, reminders, finance, skills, web
search, documents and secret coordinates; 42 are listed by default, 10 admin tools are reached by
name or with
AURELIUS_MCP_ADMIN=1. MCP Tools - Memory snapshot — a small layered slice of the graph under a hard byte budget, with a fixed JSON shape for programs. Memory
- Hybrid search — full-text plus BGE-M3 vectors, fused by RRF and optionally reranked by a cross-encoder. Search
- Task management — tasks are hub nodes with work logs, evidence runs, ripening, resolutions, leasing and a fitness gate. Task Management
- Reminders — explicit states and a journal of postponements, delivered by one daemon or at the next turn. Reminders
- Personal finance — spending, income and currency exchanges logged by voice or text through the agent, exact amounts, totals in USD at each entry's date from national-bank and market rates. Personal finance
- CLI — the
aubinary: every subcommand and flag, exit codes, provenance fields, secrets, backups and maintenance. CLI - Project sync — share one project between instances over a self-hosted server. Project Sync
- Hooks — a Claude Code plugin whose hooks call
audirectly. Hooks - Architecture and Web UI — crate layout, design choices, node types, relations and the graph viewer. Architecture
Documentation
| Document | What is inside |
|---|---|
| docs/mcp-tools.md | All 52 MCP tools by group — purpose, parameters, returns, an example — including the 10 admin tools hidden from tools/list |
| docs/memory.md | Memory snapshot, its JSON form, project membership, the search path and its settings |
| docs/tasks.md | Task lifecycle, timestamps, branches, evidence, closing, criteria, leasing, fitness gate, task commands |
| docs/reminders.md | Reminder model, the au daemon clock, reminder commands |
| docs/finance.md | Personal finance: entry model, currencies, rates and USD conversion, fin_* tools, au fin |
| docs/cli.md | Command overview, exit codes, provenance, secrets, backups, maintenance, and a reference of every au subcommand and flag |
| docs/sync.md | Project sync between instances and the sync commands |
| docs/hooks.md | Claude Code plugin hooks and what each one does |
| docs/architecture.md | Session lifecycle, crate layout, key design, node types, relations, Web UI |
| docs/roadmap.md | Released versions |
| CHANGELOG.md | Changes per release |
