Skip to main content

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 init asks 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.


Docs

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

shellbrain-0.1.13.tar.gz (161.7 kB view details)

Uploaded Source

Built Distribution

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

shellbrain-0.1.13-py3-none-any.whl (233.5 kB view details)

Uploaded Python 3

File details

Details for the file shellbrain-0.1.13.tar.gz.

File metadata

  • Download URL: shellbrain-0.1.13.tar.gz
  • Upload date:
  • Size: 161.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for shellbrain-0.1.13.tar.gz
Algorithm Hash digest
SHA256 edea47f32c494e330cce2d4072c0b9c4bfce82a0aee0984036a7b8ce5eb40a29
MD5 60ff8653e648a7b85861024e9ec8c453
BLAKE2b-256 c5896696fa8e805751ba57b5fa0623643e549349dd65cb2541bb54590d554a2f

See more details on using hashes here.

Provenance

The following attestation bundles were made for shellbrain-0.1.13.tar.gz:

Publisher: release.yml on cucupac/shellbrain

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file shellbrain-0.1.13-py3-none-any.whl.

File metadata

  • Download URL: shellbrain-0.1.13-py3-none-any.whl
  • Upload date:
  • Size: 233.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for shellbrain-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 92e63ff7445210faf2965628a3d26c13fe54bf5ca8476b2485802db525277c72
MD5 ce9edb72e7638379da4afa86a8fccc8c
BLAKE2b-256 788038fca0f3dee5768a90252253608a49fd99398020c8c4f4f862c0d599982c

See more details on using hashes here.

Provenance

The following attestation bundles were made for shellbrain-0.1.13-py3-none-any.whl:

Publisher: release.yml on cucupac/shellbrain

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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