Skip to main content

Shared memory & research journal for your AI agents — memory + journal + cockpit + runnable-markdown (mdlab) for Claude, Codex, and Gemini.

Project description

🔭 PriorStates

Shared memory & a research journal for your AI agents

License: Apache-2.0 Python 3.10+ MCP-native 100% local Stars

Coding agents are amnesiacs — every session starts cold, re-deriving what you already taught them and re-running experiments a past session already concluded. PriorStates gives Claude Code, Codex, Gemini, Copilot, and Cursor (and other MCP clients) one local memory and a searchable research journal, so what one session learns, the next one remembers.

Runs entirely on your machine · CPU-only · no API keys · no cloud calls.

This is the open-source, local-first edition — everything runs on your machine.

🌐 priorstates.com · 🎬 80-second demo · 📖 Docs

PriorStates in action: save a memory, then recall it by meaning in a brand-new agent session

Install — in one sentence

Already using Claude Code, Codex, Gemini, Copilot, or Cursor? Hand it one line:

Install PriorStates: fetch https://priorstates.com/install.md and follow it.

The agent reads AGENT_INSTALL.md, installs the package, wires itself over MCP, and verifies with priorstates doctor — then restart it to load the new tools.

Prefer to do it yourself? Pick your platform. Everything installs per-user — no root/admin: the Windows .exe and macOS .pkg are "install for me only," and the one-liner / pip / tarball stay in your home. (Only the Linux .deb/.rpm use sudo, since that's how system packages work.)

🐧 Linux — Debian/Ubuntu .deb · RHEL/Fedora .rpm

The package pulls in python3 + numpy, and you get the desktop app, an icon, the priorstates CLI and man pages:

# Debian / Ubuntu
curl -fSLO https://priorstates.com/download/priorstates-latest.deb
sudo apt install -y ./priorstates-latest.deb

# RHEL / Rocky / Alma / Fedora  (one noarch package; EL9 pulls python3.12)
curl -fSLO https://priorstates.com/download/priorstates-latest.noarch.rpm
sudo dnf install ./priorstates-latest.noarch.rpm

Then open “PriorStates” from your app menu (or run priorstates-gui). For agent integration it needs the MCP package once — PIP_BREAK_SYSTEM_PACKAGES=1 pip3 install --user mcp. sudo apt remove priorstates (or dnf remove) uninstalls. No root? Use the one-liner or pipx below — both install per-user, no sudo.

🍎 macOS — the .pkg (no admin password)

Download priorstates-latest.pkg and double-click. It's “install for me only” — no admin (signed & notarized by Apple, so no Gatekeeper prompt). Uninstall any time with sh ~/Library/PriorStates/install.sh --uninstall.

🪟 Windows — Setup.exe, or no-exe via pipx

Download and run PriorStates-Setup.exe — per-user (no admin), auto-installs Python if needed, adds Start Menu + Desktop shortcuts. Windows builds use free code signing by the SignPath Foundation.

Corporate / locked-down Windows that blocks .exe? PriorStates is a Python package — install with no installer at all:

py -m pip install --user pipx
py -m pipx install priorstates
priorstates init

(A winget package is coming soon: winget install PriorStates.PriorStates.)

📦 Any OS with Python 3.10+ — pip / pipx
pip install -U priorstates        # or: pipx install priorstates
priorstates init                  # wire Claude Code / Codex / Gemini / Copilot / Cursor over MCP
priorstates cockpit               # web cockpit → http://127.0.0.1:7700

On Debian/Ubuntu (PEP 668) use pipx install priorstates (or add --user --break-system-packages to pip).

More options (pip/pipx, source, corporate Windows, troubleshooting) → priorstates.com/install. No model download is required — a built-in CPU hashing embedder works out of the box; priorstates init --download-model (≈127 MB) upgrades to semantic recall.

What's inside

Subsystem What it does
🧠 memory A local semantic store. Save a fact once — any future session recalls it by meaning. Pinned facts are injected into every session.
📓 journal An append-only research log. Every winner, loser, bug & decision becomes a searchable entry, so no experiment is run twice.
🛰️ cockpit A pure-Python (stdlib-only) local web app that maps your memory, journal & docs — search, group, dashboards. Embedded terminal (on by default for a local cockpit; --no-terminal to disable) to run your agent CLIs right in the browser. No Node.js, no npm, no build step.
📝 mdlab Runnable Markdown: interleave prose, code & results in one file and splice output back in.

All of it is wired into your agents over the open MCP protocol by priorstates agents install — so they recall before acting and record durable conclusions back, automatically.

MCP server

priorstates agents install registers the server into Claude Code / Codex / Gemini / Copilot / Cursor for you; to run it directly over stdio: priorstates mcp. It exposes 10 tools:

  • memorymemory_add · memory_search · memory_get · memory_list_pinned · memory_pin · memory_delete
  • journaljournal_add · journal_search · journal_regen
  • mdlabmdlab_run

See it in action

The cockpit maps your whole research surface; the CLI captures and recalls from your terminal.

The PriorStates cockpit — search and manage memory, journal and docs in one local web view PriorStates CLI — capture a memory in plain English, list pinned memories, search the journal by outcome

Agent-neutral

One memory store and one journal, surfaced to Claude Code, Codex, Gemini, Copilot, and Cursor (and other MCP clients) through MCP and a pinned context block — no lock-in, no rewrites. Switch agents without losing a thing. The VS Code / JetBrains extensions for Claude Code and Codex share their CLI's MCP config, so they're covered automatically. Every client on the machine reads the same local store, so a memory saved in one is instantly recalled in all the others.

Global vs project memory

PriorStates keeps one global memory plus an optional per-project layer — and which one your agent uses follows its working directory, automatically:

  • Anywhere (no project) → the global store in ~/.priorstates/. This is what you get right after installing.
  • Inside a project you've set up with priorstates init (it creates a .priorstates/ folder in that repo) → that project's memory plus global, merged when recalling. New memories save to the project by default, so project-specific facts stay with the project and global facts stay global.

The whole rule is: memory follows the directory your agent runs in. Run an agent in a repo that has a .priorstates/ and it sees that project; run it elsewhere and it sees global. The desktop app's Projects list is just a convenient way to pick which project to browse and to launch an agent in — it doesn't change the rule. (To check where you are: priorstates doctor, or the scope badge in the cockpit.)

Private by default

Everything lives under ~/.priorstates/ and per-project .priorstates/. The default embedder is CPU-only and offline — no API keys, no telemetry, no cloud calls. Upgrade to semantic recall with a single optional ~127 MB model download whenever you want.

Removing it removes what it added. Uninstalling (Windows uninstaller, or the .pkg/tarball install.sh --uninstall) runs priorstates agents uninstall for you — taking the MCP server entry and the pinned instruction block back out of every agent it wired. Your memory under ~/.priorstates/ is left untouched. You can unwire (or re-wire) any time with priorstates agents uninstall / priorstates agents install. (For the system .deb/.rpm, run priorstates agents uninstall as your user before apt/dnf remove, since package removal runs as root and can't reach your per-user agent config.)

Share a pack

Export your memory + journal as a portable bundle and hand it to a teammate (or host it anywhere — any file or URL works):

priorstates pack export --name my-project        # → my-project.pspack
priorstates pack import ./my-project.pspack # on the other machine (or a URL)

Imported memory surfaces through the same MCP tools — no extra wiring. Imports are checksum-verified, shown for confirmation before ingest, and tagged with their source (and never auto-pinned). The cockpit has Export / Import buttons too (Import needs the cockpit started with --allow-write).

New here? Load a ready-made sample to see PriorStates populated instantly:

priorstates pack import --demo

Docs

Status

v0.1 — working end-to-end: memory, journal, mdlab, MCP server (10 tools), agent wiring (Claude Code / Codex / Gemini / Copilot / Cursor), the web cockpit, and the desktop launcher are all built and tested. Optional semantic model downloads on demand; the hashing fallback needs zero setup. A background embedder daemon and an autonomous priorstates research runner are next.

Issues and PRs welcome.

Get in touch

Questions, ideas, or feedback — service@priorstates.com. Bug reports and feature requests are welcome as GitHub issues.

License

Apache-2.0 (permissive + patent grant). See LICENSE and NOTICE. Copyright 2026 Zhendong Qin.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

priorstates-0.1.19.tar.gz (578.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

priorstates-0.1.19-py3-none-any.whl (595.9 kB view details)

Uploaded Python 3

File details

Details for the file priorstates-0.1.19.tar.gz.

File metadata

  • Download URL: priorstates-0.1.19.tar.gz
  • Upload date:
  • Size: 578.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for priorstates-0.1.19.tar.gz
Algorithm Hash digest
SHA256 f9c954c169f12db17b5adad29d0bbcbc6cf023b7bcff92828e2c043558a6f25d
MD5 51ff34a78eff2cdcc0a176cf40008659
BLAKE2b-256 0d4db22b1189a6078ea081773006aff403f8a73e6b43b87466266059f7e654eb

See more details on using hashes here.

File details

Details for the file priorstates-0.1.19-py3-none-any.whl.

File metadata

  • Download URL: priorstates-0.1.19-py3-none-any.whl
  • Upload date:
  • Size: 595.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for priorstates-0.1.19-py3-none-any.whl
Algorithm Hash digest
SHA256 50594ab28a6e1ed827bcab231114e37a10fcb413349d8ba604496413fd86f793
MD5 afeb36b4eb9f6c30b539f9831a761e3f
BLAKE2b-256 6d7c42402925b41a699ff26513fc3750cb8e6fed7e1a862d6a23c4dbd45ec345

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page