Skip to main content

Brain Framework: an exposed brain in an opening shell above twin aperture eyes

Brain Framework 🧠

🧠 Brain Framework: from information to informed actions.

Collect information from your tools, connect it to your decisions and pick up work with the evidence at hand. Reusable context for you and your AI agents.

CI PyPI Python License: MIT

Your meeting notes, issues and project decisions live in different places. Brain Framework (BF) brings selected information into a folder of Markdown notes and source records you own. Search it across sessions, trace decisions to their sources and use the same context with different agents.

Try it · Connect an agent · Four-tool demo · Documentation

What can you do with it?

Example: Turn meeting notes into GitHub issues. Collect Calendar event descriptions, then ask your agent:

Turn today's meeting notes into GitHub issues in my chosen repository. Cite the source event for each issue.

BF supplies the saved notes; your agent uses gh to create the issues you authorize. Follow the Calendar-to-issues example for setup and prerequisites.

When you need to… BF helps you…
Resume a project Find the last verified outcome and next step.
Explain a decision Read the original reasoning and linked evidence.
Check work across tools Follow explicit connections between briefs, issues and deployments.
Reuse what worked Keep lessons in notes that any editor or agent can read.

See the runnable four-tool demo: GitHub says the implementation is merged and Gcloud shows a healthy preview, but Jira still blocks launch on accessibility review. Reading all four sources explains what remains. The records are fictional; the collection and retrieval are runnable locally. The examples index also covers decision reviews, retrieval checks, hooks, routines, monitoring and team collaboration.

Try it

Start with one decision you can find again. This walkthrough needs Linux or macOS and uv, which installs the tested Python 3.14 if needed (install details). No model or provider account is required.

uv tool install --python 3.14 brain-framework
bf init ~/brain
cd ~/brain

If bf is not on PATH, run uv tool update-shell and open a new shell. You can choose another empty folder instead of ~/brain.

Create projects/new-website.md in your editor, or ask your agent to save this fictional decision. Use today's date for updated:

---
type: project
status: draft
updated: 2026-09-27
summary: Launch a product website that helps visitors understand the product.
---

# New website

## Decision

Start with a single product page because visitors need a clear explanation before signing up.

## Next actions

- [ ] Draft the product page.

Find the reason, read its source and check the brain:

bf search "visitors clear explanation"
bf read projects/new-website.md#decision
bf validate

Search returns this match in items (other fields omitted):

{ "ref": "projects/new-website.md#decision", "title": "New website — Decision" }

read returns the original Decision section; validation reports "valid":true. Edit the note and search again: BF notices changes automatically. You now have a decision an agent can find and cite.

The getting-started guide continues with a local source, a schema mapping and a link from the decision to its evidence.

Agents

Use the same brain with Claude Code, Codex, GitHub Copilot or another agent host.

Your agent can… Start with…
Run terminal commands The bf CLI and the prompt below. No skill installation needed for this first task.
Use MCP tools A stdio server running bf mcp, with explicit executable and brain paths. Follow MCP setup.

After the quickstart, give your terminal agent this prompt:

Work in ~/brain and use the bf CLI. Find why we chose a single product page. Read the source, cite its ref and tell me the project's next action.

Check that it reads the decision and next actions, cites projects/new-website.md#decision and identifies “Draft the product page.” as the next task.

MCP exposes two read-only tools: search and read. For ongoing use, install the optional workflow skills: bf-use for retrieval, bf-action to track work and bf-learn to retain verified outcomes. See the agent guide for setup and examples.

How it works

Gather → normalize → organize and connect → act → learn. Sensors collect selected evidence; configured mappings give sources shared fields and explicit relationships. You and your agents use that context to do work, then keep the outcome and next step in the brain.

brain/
├── bf.yaml      # configuration and source mappings
├── projects/    # what you're working on and why
├── concepts/    # what you've learned and can reuse
├── actions/     # work to start, resume and review
└── memories/    # evidence gathered from your sources

Notes are Markdown with structured metadata; each collected record is a JSON file. Open them in any editor and use Git for history. The local search cache is disposable. See the file conventions.

Links and backlinks connect decisions to evidence. Keep personal and shared context in separate team brains, and search related brains together. Identities and relationship meanings are explicit; BF never guesses them from similar names.

Bring your tools

A sensor is a small script that reads a CLI, API or file and prints JSON records. BF validates, maps and saves them. Start with the reviewed examples or write a script for another source:

Source Starting point
Local files, highlights and Git Document, highlight and Git history sensors.
Google Calendar and Drive Calendar and Drive folder catalog sensors using gws.
GitHub, Jira, Confluence and Google Cloud Write a sensor using gh, acli, gcloud or their APIs.

Start with one local source; use schema mappings to connect sources. Provider tools handle authentication; your script selects what to collect.

After reviewing your sensors, run bf watch to keep sources refreshed and see recent changes. See Watch and schedule updates for timing, desktop alerts and optional native schedules.

Watch dashboard for the fictional offline demo: five sensors sorted by state, with a failed sensor's details beside their last success, next due time, item count and record changes.

The dashboard above shows the fictional offline terminal demo, which runs without provider accounts.

Fit and limits

BF fits projects where decisions and evidence need to survive a chat session. Start with one recurring question and the sources needed to answer it.

  • Your files, your control. BF sends no telemetry or personal data to us. A connected cloud agent may send what it reads to its provider; see privacy and security.
  • Offline retrieval. Search and read never contact providers or run sensors. Refresh sources explicitly when you need newer evidence; incomplete retrieval is reported.
  • People and agents supply the judgment. BF uses word search and explicit identities, runs no model and does not learn automatically from conversations. Keep notes current as work changes.

Next steps

MIT licensed · Third-party notices

Metadata

Release files for brain-framework 15.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for brain-framework 15.0.0
File Size Uploaded
brain_framework-15.0.0.tar.gz 140.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for brain-framework 15.0.0
File Interpreter ABI Platform
brain_framework-15.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 296.5 kB

Release files / brain_framework-15.0.0.tar.gz

Download URL brain_framework-15.0.0.tar.gz
Size 140.2 kB
Tags Source
SHA-256 checksum
How to use checksums
628233ab8337d32d2d87ae2cf77a339dd66ee3f75a2613d5fdbac9bbccac2de4
BLAKE2b-256 checksum
How to use checksums
5ebd91ca7456c477cff655bf6d202b1b4325cc0efdc8783ec42e25ba18499425
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.

Transparency log

Release files / brain_framework-15.0.0-py3-none-any.whl

Download URL brain_framework-15.0.0-py3-none-any.whl
Size 156.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6e65a9ba4f79b3eb9af14d988dd8eca3eeaa7967c979ccbfacf80372e3174386
BLAKE2b-256 checksum
How to use checksums
a8d15dd65c17984d95028963501136578749b8fbd376f8ea299c274a65dadd00
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.

Transparency log

Release history Release notifications | RSS feed

18.5.0

2 release files

18.4.0

2 release files

16.1.1

2 release files

16.1.0

2 release files

16.0.1

2 release files

This release

15.0.0 This release

2 release files

14.0.0

2 release files

13.0.2

2 release files

12.0.2

2 release files

12.0.0

2 release files

11.1.1

2 release files

11.0.0

2 release files

10.0.0

2 release files

9.2.0

2 release files

9.1.0

2 release files

9.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page