Durable context for long-running agents.
Project description
Remaind
Durable context for long-running agents.
Remaind is a local-first context ledger, compaction pipeline, and resume substrate for AI agents. It preserves the meaningful state of an agent run across context resets: a future agent can start with a clean model context, load Remaind's local state, understand what happened before, know what must happen next, and continue safely without asking the user to reconstruct the work.
Remaind is not a wiki — it is a machine-readable and human-readable continuity layer: raw event ledger, structured state, compact handover, searchable memory, structured validation, safe rollback, and a mechanical resume gate.
Install
git clone https://github.com/magpiexyz-lab/Remaind.git
cd Remaind
python3 -m venv .venv
.venv/bin/pip install -e ".[dev]"
Requires Python ≥ 3.11.
Quick start
# Bootstrap a .context/ in the current directory.
remaind init
# Inspect what's there.
remaind validate
remaind status
# After work happens (events appended by your agent harness),
# compact when token band climbs.
remaind compact
# Build a resume packet for a fresh agent run.
remaind resume --next-tool deploy_prod
# Roll back if something went wrong.
remaind rollback --to 2026-05-14T03:54:33Z
What lives in .context/
.context/
├── README.md
├── CONTRACT.md # the contract — read this first
├── active/
│ ├── state.json # derived working state (atomic replace)
│ ├── handover.md # compact continuity document (atomic replace)
│ └── (resume_packet.md, history/ — runtime, git-ignored)
├── logs/
│ └── events.jsonl # append-only raw timeline (source of truth)
├── schemas/
│ ├── event.schema.json # JSON Schema Draft 2020-12
│ ├── state.schema.json
│ ├── memory.schema.json
│ ├── validation.schema.json
│ ├── thresholds.yaml # 40k/60k/70k/80k band math
│ ├── redaction.yaml # 9 default secret patterns
│ ├── tools.yaml # mechanical risk flags
│ └── migrations/{state,events}/
└── (db/context.sqlite, artifacts/ — runtime, git-ignored)
Authority order
When sources disagree, lower wins:
- Latest explicit user instruction
- Raw event log (
logs/events.jsonl) active/state.jsonactive/handover.md- Derived memories
A stale summary or memory MUST NOT override a newer user instruction.
Commands
| Command | What it does |
|---|---|
remaind init |
Bootstrap .context/; --force backs up existing |
remaind validate |
Walk the v1 checklist (structure, schemas, events, SQLite) |
remaind status [--json] |
State + thresholds + event counts + compaction recommendation |
remaind compact |
Run the compaction pipeline, gated by structured validation |
remaind resume [--next-tool TOOL] |
Build a resume packet; consult the resume gate |
remaind rollback --to <ts> |
Restore derived files from history; raw log untouched |
Architecture
| Phase | Subject |
|---|---|
| 1 | Frozen contract — schemas, configs, layout |
| 2 | Migration interfaces — state migrations + event adapters (Protocols) |
| 3 | init + validate + schema/config loaders + JSONL streaming |
| 4 | Redaction engine + content-addressed artifact store + append-only event writer |
| 5 | Atomic state/handover writes + history snapshots + threshold band recompute |
| 6 | status human/JSON inspector |
| 7 | SQLite memory + FTS5 (memories, memories_fts, events_index) |
| 8 | chars/4 token estimator + compaction-needed surface |
| 9 | Source-event selection + reference compactor |
| 10 | Structured compaction validator (reject-on-any-false) |
| 11 | Resume packet builder + mechanical resume gate |
| 12 | Rollback (restores derived files; raw log untouched) |
V1 non-goals
No vector search, no multi-writer semantics, no cross-project global user memory, no procedural memory, no remote sync, no hosted UI, no provider-managed conversation state as a dependency, no destructive raw-log migration.
Hard rules
- Do not rewrite
events.jsonl. - Do not let summaries become source of truth.
- Do not store secrets in raw logs.
- Do not store huge outputs inline (threshold: 4096 bytes).
- Do not allow stale memory to override latest user instruction.
- Do not accept compaction without structured validation.
- Do not mutate files on resume if the resume packet is contradictory or unsafe.
Tests
.venv/bin/python -m pytest -q
177 tests covering every phase. Adding a feature? Add a test.
License
MIT — see LICENSE.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file remaind-0.1.2.tar.gz.
File metadata
- Download URL: remaind-0.1.2.tar.gz
- Upload date:
- Size: 2.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
02ae802d9da1e5f6014bc37e1e933c02ffee07698865ea6e6371a671fcaee2cf
|
|
| MD5 |
9f95fa02160dbe6503d392ea79debe09
|
|
| BLAKE2b-256 |
3ee650b69c6a70b9b8e1ee1d98a49a5ca828483156b807bfc02e9087f3aa81b0
|
Provenance
The following attestation bundles were made for remaind-0.1.2.tar.gz:
Publisher:
release.yml on magpiexyz-lab/Remaind
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
remaind-0.1.2.tar.gz -
Subject digest:
02ae802d9da1e5f6014bc37e1e933c02ffee07698865ea6e6371a671fcaee2cf - Sigstore transparency entry: 1532540229
- Sigstore integration time:
-
Permalink:
magpiexyz-lab/Remaind@fc35db74e4eedf015c6e641b9f68c1ede92ff628 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/magpiexyz-lab
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@fc35db74e4eedf015c6e641b9f68c1ede92ff628 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file remaind-0.1.2-py3-none-any.whl.
File metadata
- Download URL: remaind-0.1.2-py3-none-any.whl
- Upload date:
- Size: 65.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
438eb2302f356943b9cb22ec78a41790a58ec5ce213c6de7e10a673737103c2e
|
|
| MD5 |
efc44732e9c1e777af0b0f78aab336fb
|
|
| BLAKE2b-256 |
a223eb6fe64023fc9012df989fded3e0934fc7ededcef62f6c818f5be92c32d3
|
Provenance
The following attestation bundles were made for remaind-0.1.2-py3-none-any.whl:
Publisher:
release.yml on magpiexyz-lab/Remaind
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
remaind-0.1.2-py3-none-any.whl -
Subject digest:
438eb2302f356943b9cb22ec78a41790a58ec5ce213c6de7e10a673737103c2e - Sigstore transparency entry: 1532540336
- Sigstore integration time:
-
Permalink:
magpiexyz-lab/Remaind@fc35db74e4eedf015c6e641b9f68c1ede92ff628 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/magpiexyz-lab
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@fc35db74e4eedf015c6e641b9f68c1ede92ff628 -
Trigger Event:
workflow_dispatch
-
Statement type: