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 and Claude skills, wires the Claude SessionStart hook, and runs shellbrain init for you when the managed-local prerequisites are met. Repos register themselves on first use.

Managed-local requirements

  • macOS or Linux
  • Python 3.11+ required
  • Docker installed and the daemon running
  • first init downloads a local embedding model
  • PostgreSQL + pgvector run inside the managed Docker runtime
  • Windows is not supported yet
  • external Postgres remains an advanced/operator-managed path for now

The repo Dockerfile is for packaging and development smoke coverage. It is not the end-user runtime path.


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.

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.8.tar.gz (140.9 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.8-py3-none-any.whl (205.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: shellbrain-0.1.8.tar.gz
  • Upload date:
  • Size: 140.9 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.8.tar.gz
Algorithm Hash digest
SHA256 343d838e199db773f64023816a9d41aee9f301795128b65e9917f2ff6abf7a5f
MD5 89b1a268525b331bd36564e3ceca14f6
BLAKE2b-256 f96e77973f0fb7f62937e7ef55d465fbc8e1e0f0318eb025aaf7a4c8b6ba8ca8

See more details on using hashes here.

Provenance

The following attestation bundles were made for shellbrain-0.1.8.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.8-py3-none-any.whl.

File metadata

  • Download URL: shellbrain-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 205.7 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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 013bfe2ae876ab1f9ae36110dfcb178c44db02c20a1c077540c39f0fadf25aa0
MD5 5f52ed19ad0b111f9041381e09be8fdd
BLAKE2b-256 4c0452925f3ab67c96e879f39349875d270a9006c4b03c1e2572885b4ed21e0c

See more details on using hashes here.

Provenance

The following attestation bundles were made for shellbrain-0.1.8-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