Brain Framework 🧠¶
🧠 Brain Framework: from information to informed actions.
Keep selected evidence, decisions and next steps in a folder you can inspect and edit. Brain Framework (BF) makes those files searchable and connects them through explicit links. You and your agents use the same evidence; no BF account or model is required.
Start with Getting started: save a decision, find its reason and check the result. You need Linux or macOS, a terminal and a text editor.
Follow the work from evidence to outcome¶
| Step | In the website example |
|---|---|
| Gather | A small sensor reads a selected brief. |
| Normalize | BF maps its fields and saves a record with a stable ref. |
| Organize and connect | The project links its decision to that record. |
| Act | You review the page and record the result in an action. |
| Learn | When the brief changes, BF flags the project; you update it and keep a useful lesson as a concept. |
Start with notes; add sources, routines and prompts as the work needs them. The four-tool walkthrough runs the whole loop on fictional Workspace, Jira, GitHub and Gcloud evidence.
Choose a guide¶
| Need | Start here |
|---|---|
| Learn by doing | Getting started, then the four-tool walkthrough. |
| Understand the model | Core concepts, including the glossary and what BF does not do. |
| Use it each day | Write notes, search and read, link knowledge and check your brain. |
| Collect and automate | Add a sensor, run routines and prompts, then watch and schedule. |
| Work with others | Use an agent, connect one with MCP or set up a team brain. |
| Look up exact behavior | Commands, configuration, file formats, link rules, the retrieval reference and limits. |
| Resolve a problem | Troubleshooting, install and update or the changelog. |
Know the boundaries¶
Notes are Markdown; collected records are JSON. A disposable SQLite cache makes them searchable by words and by exact names, such as a repository address, without any AI model. You choose what to collect and share, and programs run only when you ask. A cloud agent may send what it reads to its provider: read Privacy and security before connecting sensitive sources.
These docs follow the repository's current code. Check bf --version and bf COMMAND --help if an option differs; see version differences. Agents can read them as Markdown.