Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

## Unreleased

- The repository was renamed from `samrusani/AliceBot` to
`samrusani/AliceMemory` on 2026-08-14, matching the `alice-memory` package
name and the alicememory.com domain. Documents under `docs/release/` and
`docs/archive/` intentionally retain the former name: they describe artifacts
that were built and signed from it, and PyPI's attestations bind those bytes
to the old slug permanently. The Python module, console scripts, database
roles and install paths are unchanged.

## v0.15.2 — 2026-08-14

- `/v1` now requires an agent API key once one has been provisioned. Before
Expand Down
62 changes: 31 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@

**The continuity layer for AI agents.**

[![LongMemEval](https://img.shields.io/badge/LongMemEval__s-79.4%25-6f42c1)](https://github.com/samrusani/AliceBot/blob/main/docs/benchmarks/longmemeval/README.md)
[![LongMemEval](https://img.shields.io/badge/LongMemEval__s-79.4%25-6f42c1)](https://github.com/samrusani/AliceMemory/blob/main/docs/benchmarks/longmemeval/README.md)
![Local-first](https://img.shields.io/badge/local--first-core-0A7B61)
![MCP](https://img.shields.io/badge/MCP-supported-1f6feb)
![Python](https://img.shields.io/badge/python-3.12%2B-3776AB)
![License](https://img.shields.io/badge/license-MIT-2ea043)

Alice is a local-first memory service that lets AI agents resume interrupted work, track open loops, recall decisions with provenance, and improve when corrected — instead of re-reading transcripts or trusting opaque summaries.

In one historical run dated 2026-07-07, it scored **79.4%** on [LongMemEval](https://github.com/samrusani/AliceBot/blob/main/docs/benchmarks/longmemeval/README.md), a long-term-memory benchmark. That is a single-run receipt, not a repeated-run estimate or a measurement of the current release; it includes one disclosed trade-off on the abstention subset (25/30 → 22/30). The full per-question evidence, methodology, and reproduction script are committed to this repo. Open source, local-first, MIT-licensed.
In one historical run dated 2026-07-07, it scored **79.4%** on [LongMemEval](https://github.com/samrusani/AliceMemory/blob/main/docs/benchmarks/longmemeval/README.md), a long-term-memory benchmark. That is a single-run receipt, not a repeated-run estimate or a measurement of the current release; it includes one disclosed trade-off on the abstention subset (25/30 → 22/30). The full per-question evidence, methodology, and reproduction script are committed to this repo. Open source, local-first, MIT-licensed.

Agents connect over MCP, HTTP API, or CLI. Humans stay in control: agent writes land as policy-checked commits or reviewable proposals, and a local review console is where memory gets approved, corrected, or forgotten. That review boundary is a feature, not a limitation — it is what makes the memory trustworthy enough to act on.

Expand Down Expand Up @@ -57,7 +57,7 @@ MCP client config (Claude Desktop, IDEs) — note there is no `DATABASE_URL`:
}
```

SQLite mode is the trial and single-agent path: it serves the eleven core tools for one user, and memory review happens through `alice_memory_review` / `alice_memory_correct` instead of the web console. Boundaries are listed in [known limitations](https://github.com/samrusani/AliceBot/blob/main/docs/alpha/known-limitations.md).
SQLite mode is the trial and single-agent path: it serves the eleven core tools for one user, and memory review happens through `alice_memory_review` / `alice_memory_correct` instead of the web console. Boundaries are listed in [known limitations](https://github.com/samrusani/AliceMemory/blob/main/docs/alpha/known-limitations.md).

> **Install note:** the PyPI package is [`alice-memory`](https://pypi.org/project/alice-memory/). The name `alice-core` on PyPI belongs to an unrelated project.

Expand All @@ -68,8 +68,8 @@ memory scheduler workflows — run from a repo checkout. Requirements: Python
3.12+, Node 20+, pnpm, Docker, Git.

```bash
git clone https://github.com/samrusani/AliceBot.git
cd AliceBot
git clone https://github.com/samrusani/AliceMemory.git
cd AliceMemory
make setup
make migrate
make doctor
Expand All @@ -81,7 +81,7 @@ make dev
- `make doctor` runs readiness checks and applies safe fixes.
- `make dev` runs the API on port 8000 and the web review console on port 3000.

Open the review console at `http://localhost:3000/vnext`. The detailed walkthrough — demo data, smoke checks, first memory — is in [the alpha quickstart](https://github.com/samrusani/AliceBot/blob/main/docs/alpha/quickstart.md).
Open the review console at `http://localhost:3000/vnext`. The detailed walkthrough — demo data, smoke checks, first memory — is in [the alpha quickstart](https://github.com/samrusani/AliceMemory/blob/main/docs/alpha/quickstart.md).

## Connect an agent

Expand Down Expand Up @@ -119,11 +119,11 @@ The core MCP surface is eleven tools:
- `alice_memory_manage` — confirm, undo, or forget a committed memory, audit trail intact
- `alice_explain` — provenance and trust explanation for a memory

Calling directly from a human client (Claude Desktop, an IDE)? `alice_memory_commit` needs only `title` and `canonical_text` — no identity fields. Agent integrations declare `agent_id` and `agent_type`; see [agent integration](https://github.com/samrusani/AliceBot/blob/main/docs/alpha/agent-integration.md).
Calling directly from a human client (Claude Desktop, an IDE)? `alice_memory_commit` needs only `title` and `canonical_text` — no identity fields. Agent integrations declare `agent_id` and `agent_type`; see [agent integration](https://github.com/samrusani/AliceMemory/blob/main/docs/alpha/agent-integration.md).

The write verbs follow one contract — outcomes, audit guarantees, and honest boundaries per verb are documented in the [Memory Operations Protocol](https://github.com/samrusani/AliceBot/blob/main/docs/memory-operations-protocol.md). Removed backing services no longer have MCP tools. Retained long-tail memory tools require `ALICE_MCP_LEGACY_TOOLS=1`; exactly `alice_task_brief`, `alice_task_brief_show`, and `alice_task_brief_compare` additionally require `ALICE_LEGACY_SURFACES=1`. All legacy tools require a deliberately keyless local-operator deployment; a server bound with `ALICE_AGENT_API_KEY` exposes only the policy-complete core surface.
The write verbs follow one contract — outcomes, audit guarantees, and honest boundaries per verb are documented in the [Memory Operations Protocol](https://github.com/samrusani/AliceMemory/blob/main/docs/memory-operations-protocol.md). Removed backing services no longer have MCP tools. Retained long-tail memory tools require `ALICE_MCP_LEGACY_TOOLS=1`; exactly `alice_task_brief`, `alice_task_brief_show`, and `alice_task_brief_compare` additionally require `ALICE_LEGACY_SURFACES=1`. All legacy tools require a deliberately keyless local-operator deployment; a server bound with `ALICE_AGENT_API_KEY` exposes only the policy-complete core surface.

Custom agents calling the HTTP API authenticate with per-agent API keys. See [agent integration](https://github.com/samrusani/AliceBot/blob/main/docs/alpha/agent-integration.md).
Custom agents calling the HTTP API authenticate with per-agent API keys. See [agent integration](https://github.com/samrusani/AliceMemory/blob/main/docs/alpha/agent-integration.md).

### Embeddings

Expand Down Expand Up @@ -169,37 +169,37 @@ What that means in practice:

## Docs

- [Quickstart walkthrough](https://github.com/samrusani/AliceBot/blob/main/docs/alpha/quickstart.md)
- [Agent integration](https://github.com/samrusani/AliceBot/blob/main/docs/alpha/agent-integration.md)
- [MCP tools](https://github.com/samrusani/AliceBot/blob/main/docs/alpha/mcp-tools.md)
- [Custom agent guide](https://github.com/samrusani/AliceBot/blob/main/docs/alpha/custom-agent-guide.md)
- [Known limitations](https://github.com/samrusani/AliceBot/blob/main/docs/alpha/known-limitations.md)
- [Backup and restore](https://github.com/samrusani/AliceBot/blob/main/docs/alpha/backup-and-restore.md)
- [Disaster recovery](https://github.com/samrusani/AliceBot/blob/main/docs/runbooks/disaster-recovery.md)
- [Health and monitoring](https://github.com/samrusani/AliceBot/blob/main/docs/runbooks/health-and-monitoring.md)
- [Upgrade v0.12.0 to current](https://github.com/samrusani/AliceBot/blob/main/docs/runbooks/upgrade-v0.12-to-current.md)
- [Security and privacy](https://github.com/samrusani/AliceBot/blob/main/docs/alpha/security-and-privacy.md)
- [v0.10.4 release notes](https://github.com/samrusani/AliceBot/blob/main/docs/release/v0.10.4-release-notes.md)
- [v0.11.0 release notes](https://github.com/samrusani/AliceBot/blob/main/docs/release/v0.11.0-release-notes.md)
- [v0.11.1 release notes](https://github.com/samrusani/AliceBot/blob/main/docs/release/v0.11.1-release-notes.md)
- [v0.12.0 release notes](https://github.com/samrusani/AliceBot/blob/main/docs/release/v0.12.0-release-notes.md)
- [v0.15.2 release notes](https://github.com/samrusani/AliceBot/blob/main/docs/release/v0.15.2-release-notes.md)
- [Release procedure](https://github.com/samrusani/AliceBot/blob/main/RELEASING.md)
- [Architecture](https://github.com/samrusani/AliceBot/blob/main/ARCHITECTURE.md)
- [Roadmap](https://github.com/samrusani/AliceBot/blob/main/ROADMAP.md)
- [Changelog](https://github.com/samrusani/AliceBot/blob/main/CHANGELOG.md)
- [Quickstart walkthrough](https://github.com/samrusani/AliceMemory/blob/main/docs/alpha/quickstart.md)
- [Agent integration](https://github.com/samrusani/AliceMemory/blob/main/docs/alpha/agent-integration.md)
- [MCP tools](https://github.com/samrusani/AliceMemory/blob/main/docs/alpha/mcp-tools.md)
- [Custom agent guide](https://github.com/samrusani/AliceMemory/blob/main/docs/alpha/custom-agent-guide.md)
- [Known limitations](https://github.com/samrusani/AliceMemory/blob/main/docs/alpha/known-limitations.md)
- [Backup and restore](https://github.com/samrusani/AliceMemory/blob/main/docs/alpha/backup-and-restore.md)
- [Disaster recovery](https://github.com/samrusani/AliceMemory/blob/main/docs/runbooks/disaster-recovery.md)
- [Health and monitoring](https://github.com/samrusani/AliceMemory/blob/main/docs/runbooks/health-and-monitoring.md)
- [Upgrade v0.12.0 to current](https://github.com/samrusani/AliceMemory/blob/main/docs/runbooks/upgrade-v0.12-to-current.md)
- [Security and privacy](https://github.com/samrusani/AliceMemory/blob/main/docs/alpha/security-and-privacy.md)
- [v0.10.4 release notes](https://github.com/samrusani/AliceMemory/blob/main/docs/release/v0.10.4-release-notes.md)
- [v0.11.0 release notes](https://github.com/samrusani/AliceMemory/blob/main/docs/release/v0.11.0-release-notes.md)
- [v0.11.1 release notes](https://github.com/samrusani/AliceMemory/blob/main/docs/release/v0.11.1-release-notes.md)
- [v0.12.0 release notes](https://github.com/samrusani/AliceMemory/blob/main/docs/release/v0.12.0-release-notes.md)
- [v0.15.2 release notes](https://github.com/samrusani/AliceMemory/blob/main/docs/release/v0.15.2-release-notes.md)
- [Release procedure](https://github.com/samrusani/AliceMemory/blob/main/RELEASING.md)
- [Architecture](https://github.com/samrusani/AliceMemory/blob/main/ARCHITECTURE.md)
- [Roadmap](https://github.com/samrusani/AliceMemory/blob/main/ROADMAP.md)
- [Changelog](https://github.com/samrusani/AliceMemory/blob/main/CHANGELOG.md)

## Contributing

Issues, integrations, importers, and eval contributions are welcome. See [CONTRIBUTING.md](https://github.com/samrusani/AliceBot/blob/main/CONTRIBUTING.md).
Issues, integrations, importers, and eval contributions are welcome. See [CONTRIBUTING.md](https://github.com/samrusani/AliceMemory/blob/main/CONTRIBUTING.md).

## Security

If you discover a security issue, follow the process in [SECURITY.md](https://github.com/samrusani/AliceBot/blob/main/SECURITY.md).
If you discover a security issue, follow the process in [SECURITY.md](https://github.com/samrusani/AliceMemory/blob/main/SECURITY.md).

## License

MIT — see [LICENSE](https://github.com/samrusani/AliceBot/blob/main/LICENSE).
MIT — see [LICENSE](https://github.com/samrusani/AliceMemory/blob/main/LICENSE).

`v0.15.2` is the latest published release and remains the install, checksum,
and baseline reference.
4 changes: 2 additions & 2 deletions docs/alpha/headless-ubuntu-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ deployment.
## Inspect-Before-Run Install

```bash
curl -fsSL https://raw.githubusercontent.com/samrusani/AliceBot/main/scripts/install-ubuntu.sh -o install-alice.sh
curl -fsSL https://raw.githubusercontent.com/samrusani/AliceMemory/main/scripts/install-ubuntu.sh -o install-alice.sh
less install-alice.sh
bash install-alice.sh --branch main --install-dir ~/alicebot
```
Expand Down Expand Up @@ -124,7 +124,7 @@ connector configuration.
```bash
sudo apt-get update
sudo apt-get install -y ca-certificates curl git build-essential python3 python3-venv python3-pip libpq-dev postgresql postgresql-contrib postgresql-16-pgvector
git clone https://github.com/samrusani/AliceBot.git ~/alicebot
git clone https://github.com/samrusani/AliceMemory.git ~/alicebot
cd ~/alicebot
git checkout main
python3 -m venv .venv
Expand Down
4 changes: 2 additions & 2 deletions docs/alpha/onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ onboarding program.
## Install

```bash
git clone https://github.com/samrusani/AliceBot.git
cd AliceBot
git clone https://github.com/samrusani/AliceMemory.git
cd AliceMemory
cp .env.example .env
make setup
make migrate
Expand Down
4 changes: 2 additions & 2 deletions docs/alpha/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ This is the trial and single-agent path: the eleven core MCP tools for one user,
## Setup

```bash
git clone https://github.com/samrusani/AliceBot.git
cd AliceBot
git clone https://github.com/samrusani/AliceMemory.git
cd AliceMemory
make setup
make migrate
make doctor
Expand Down
4 changes: 2 additions & 2 deletions docs/deployment/single-tenant-self-hosted.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ configuration-management layer before installing files, then verify them:
```bash
id alicebot
getent group alicebot
git clone https://github.com/samrusani/AliceBot.git /opt/alicebot
git clone https://github.com/samrusani/AliceMemory.git /opt/alicebot
cd /opt/alicebot
git fetch --tags --force
ALICE_RELEASE_REF='replace-with-verified-tag-or-sha'
Expand Down Expand Up @@ -407,7 +407,7 @@ or use the equivalent container-namespace inspection for another supervisor;
never dump `/proc/.../environ` into logs or a receipt.

```bash
api_pid="$(systemctl show --property MainPID --value alicebot-api.service)"
api_pid="$(systemctl show --property MainPID --value alice-api.service)"
test "$api_pid" -gt 0
sudo /opt/alicebot/.venv/bin/python - "$api_pid" <<'PY'
import sys
Expand Down
6 changes: 3 additions & 3 deletions docs/pypi-description.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ and `alicebot-mcp` entrypoints.

## Learn more

- [Source and documentation](https://github.com/samrusani/AliceBot)
- [Release history](https://github.com/samrusani/AliceBot/releases)
- [Issue tracker](https://github.com/samrusani/AliceBot/issues)
- [Source and documentation](https://github.com/samrusani/AliceMemory)
- [Release history](https://github.com/samrusani/AliceMemory/releases)
- [Issue tracker](https://github.com/samrusani/AliceMemory/issues)

Alice is evolving software. Review the project documentation and release
history before deploying it in a production workflow.
4 changes: 2 additions & 2 deletions docs/quickstart/local-setup-and-first-result.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ The canonical setup walkthrough lives at [docs/alpha/quickstart.md](../alpha/qui
Short version:

```bash
git clone https://github.com/samrusani/AliceBot.git
cd AliceBot
git clone https://github.com/samrusani/AliceMemory.git
cd AliceMemory
make setup
make migrate
make doctor
Expand Down
6 changes: 3 additions & 3 deletions docs/vnext/local-runtime.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,9 @@ Use [docs/runbooks/vnext-local-scheduler.service](../runbooks/vnext-local-schedu

```bash
systemctl --user daemon-reload
systemctl --user enable --now alicebot-vnext-scheduler.service
systemctl --user status alicebot-vnext-scheduler.service
systemctl --user stop alicebot-vnext-scheduler.service
systemctl --user enable --now alice-scheduler.service
systemctl --user status alice-scheduler.service
systemctl --user stop alice-scheduler.service
```

## Validation
Expand Down
4 changes: 2 additions & 2 deletions docs/vnext/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ The canonical setup walkthrough lives at [docs/alpha/quickstart.md](../alpha/qui
Short version:

```bash
git clone https://github.com/samrusani/AliceBot.git
cd AliceBot
git clone https://github.com/samrusani/AliceMemory.git
cd AliceMemory
make setup
make migrate
make doctor
Expand Down
8 changes: 4 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ dependencies = [
]

[project.urls]
Homepage = "https://github.com/samrusani/AliceBot"
Repository = "https://github.com/samrusani/AliceBot"
Issues = "https://github.com/samrusani/AliceBot/issues"
Changelog = "https://github.com/samrusani/AliceBot/blob/main/CHANGELOG.md"
Homepage = "https://github.com/samrusani/AliceMemory"
Repository = "https://github.com/samrusani/AliceMemory"
Issues = "https://github.com/samrusani/AliceMemory/issues"
Changelog = "https://github.com/samrusani/AliceMemory/blob/main/CHANGELOG.md"

[project.optional-dependencies]
dev = [
Expand Down
2 changes: 1 addition & 1 deletion scripts/install-ubuntu.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash
set -euo pipefail

REPO_URL="${ALICEBOT_REPO_URL:-https://github.com/samrusani/AliceBot.git}"
REPO_URL="${ALICEBOT_REPO_URL:-https://github.com/samrusani/AliceMemory.git}"
TAG=""
BRANCH="main"
INSTALL_DIR="${HOME}/alicebot"
Expand Down
Loading