Repo-scoped Shellbrain CLI with explicit evidence-backed writes.
Project description
Building a Brain
Shellbrain gives agent sessions repo-scoped long-term memory. It stores what happened, what worked, what failed, and what the human prefers — then retrieves the relevant pieces the moment a similar problem surfaces. Every session compounds into the next.
Install
curl -L shellbrain.ai/install | bash
One command on supported machines. The installer provisions the local runtime, installs the Codex, Claude, and Cursor skills, wires the Claude SessionStart hook, and runs shellbrain init for you. On first bootstrap, shellbrain init asks how it should store data. Repos register themselves on first use.
Requirements
- macOS or Linux
- Python 3.11+ required
shellbrain initasks you to choose one storage mode on first bootstrap- managed local: Docker installed and the daemon running
- external: PostgreSQL with pgvector
- first init downloads a local embedding model
- Windows is not supported yet
Upgrade
shellbrain upgrade
Upgrades the package and reruns init. Skills, hooks, and the managed runtime all refresh in one pass.
The install script also works as an upgrade path — curl -L shellbrain.ai/upgrade | bash if you prefer. Manual alternative: pipx upgrade shellbrain && shellbrain init.
Use it
You use shellbrain by launching a skill in your agent.
Codex: Use $shellbrain-session-start to get up to speed in this repo with shellbrain and record durable evidence-backed learnings.
Claude Code: Use Shellbrain Session Start to get up to speed in this repo with shellbrain and record durable evidence-backed learnings.
Cursor: Use shellbrain-session-start to get up to speed in this repo with shellbrain and record durable evidence-backed learnings.
The agent handles everything from there — reading prior context, gathering evidence, writing durable memories at session end. You don't manage any of this directly.
Four operations
read retrieves durable memories related to a concrete problem. Re-run whenever the search shifts.
events syncs the active transcript. Returns episode event ids to cite as evidence. Run before every write.
create writes one durable memory. At least one evidence reference required.
update records utility votes, truth-evolution links, explicit associations, or archive state.
The rhythm: read first, events before writes, create/update at session end. Do not rerun shellbrain init every session.
Repair
shellbrain admin doctor is the inspect path when something feels wrong.
shellbrain init is the repair path if doctor says repair_needed. The installer already ran it once — you only rerun it to fix things.
If shellbrain isn't found in a tool shell, retry through the shell-specific path the installer configured:
zsh -lc 'source ~/.zprofile >/dev/null 2>&1; shellbrain --help'
bash -lc 'source ~/.bash_profile >/dev/null 2>&1; shellbrain --help'
Fish PATH setup is written to ~/.config/fish/conf.d/shellbrain.fish.
DB-backed tests
Live memories and DB-backed tests now use different Postgres hosts.
- managed local Shellbrain keeps durable memories on the machine-owned managed instance
- DB-backed tests and scratch validation should use the dedicated repo-owned test host from
docker-compose.test.yml scripts/run_testsprovisions a disposable test database on that dedicated host by defaultscripts/storage_statusshows the live managed target, the dedicated test host, and any legacy local test host that is still hanging around
If you are running managed local Shellbrain, do not leave a stale SHELLBRAIN_DB_DSN export in your shell profile that points at the old local compose database. The machine config wins anyway, and the stale env var just makes the storage layout harder to reason about.
Docs
- shellbrain.ai/humans — install, upgrade, getting started
- shellbrain.ai/agents — how agents use shellbrain, with a sitemap to every page
- shellbrain.ai/recall — how the read pipeline works
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 shellbrain-0.1.29.tar.gz.
File metadata
- Download URL: shellbrain-0.1.29.tar.gz
- Upload date:
- Size: 346.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d90fcc7e98685e590b38f3555532ca11e752cbe201f853ccf0dc3b8f2ef31a69
|
|
| MD5 |
2ae43c697df889ac746b8704eaee1fbd
|
|
| BLAKE2b-256 |
9603b56bd7ddf1bb20cd1fcb693c4a2135fad3ef10618cbcd888266b20e04941
|
Provenance
The following attestation bundles were made for shellbrain-0.1.29.tar.gz:
Publisher:
release.yml on cucupac/shellbrain
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
shellbrain-0.1.29.tar.gz -
Subject digest:
d90fcc7e98685e590b38f3555532ca11e752cbe201f853ccf0dc3b8f2ef31a69 - Sigstore transparency entry: 1396201819
- Sigstore integration time:
-
Permalink:
cucupac/shellbrain@afba81e480ae9a35e6398fe7be2ff21ec4e0086a -
Branch / Tag:
refs/tags/v0.1.29 - Owner: https://github.com/cucupac
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@afba81e480ae9a35e6398fe7be2ff21ec4e0086a -
Trigger Event:
push
-
Statement type:
File details
Details for the file shellbrain-0.1.29-py3-none-any.whl.
File metadata
- Download URL: shellbrain-0.1.29-py3-none-any.whl
- Upload date:
- Size: 427.4 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 |
db61f12822738c2cf638c1bde9c16c61150d055a724cccf826f933db0d8015ac
|
|
| MD5 |
dcc7dc0b3d34c15d8c30f15862439917
|
|
| BLAKE2b-256 |
b094d39e44e3669cd063f27170f0f63a749b8b19a53b843e50cb96f5e26a962b
|
Provenance
The following attestation bundles were made for shellbrain-0.1.29-py3-none-any.whl:
Publisher:
release.yml on cucupac/shellbrain
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
shellbrain-0.1.29-py3-none-any.whl -
Subject digest:
db61f12822738c2cf638c1bde9c16c61150d055a724cccf826f933db0d8015ac - Sigstore transparency entry: 1396201826
- Sigstore integration time:
-
Permalink:
cucupac/shellbrain@afba81e480ae9a35e6398fe7be2ff21ec4e0086a -
Branch / Tag:
refs/tags/v0.1.29 - Owner: https://github.com/cucupac
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@afba81e480ae9a35e6398fe7be2ff21ec4e0086a -
Trigger Event:
push
-
Statement type: