# 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](<https://fmind.github.io/brain-framework/docs/getting-started/index.md>): 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](<https://fmind.github.io/brain-framework/docs/context-hub/index.md>) runs the whole loop on fictional Workspace, Jira, GitHub and Gcloud evidence.

## Choose a guide

| Need | Start here |
| --- | --- |
| Learn by doing | [Getting started](<https://fmind.github.io/brain-framework/docs/getting-started/index.md>), then the [four-tool walkthrough](<https://fmind.github.io/brain-framework/docs/context-hub/index.md>). |
| Understand the model | [Core concepts](<https://fmind.github.io/brain-framework/docs/concepts/index.md>), including the glossary and what BF does not do. |
| Use it each day | [Write notes](<https://fmind.github.io/brain-framework/docs/brain/index.md>), [search and read](<https://fmind.github.io/brain-framework/docs/search/index.md>), [link knowledge](<https://fmind.github.io/brain-framework/docs/links/index.md>) and [check your brain](<https://fmind.github.io/brain-framework/docs/checks/index.md>). |
| Collect and automate | [Add a sensor](<https://fmind.github.io/brain-framework/docs/sensors/index.md>), [run routines](<https://fmind.github.io/brain-framework/docs/routines/index.md>) and [prompts](<https://fmind.github.io/brain-framework/docs/prompts/index.md>), then [watch and schedule](<https://fmind.github.io/brain-framework/docs/schedule/index.md>). |
| Work with others | [Use an agent](<https://fmind.github.io/brain-framework/docs/agents/index.md>), [connect one with MCP](<https://fmind.github.io/brain-framework/docs/mcp/index.md>) or [set up a team brain](<https://fmind.github.io/brain-framework/docs/team/index.md>). |
| Look up exact behavior | [Commands](<https://fmind.github.io/brain-framework/docs/commands/index.md>), [configuration](<https://fmind.github.io/brain-framework/docs/configuration/index.md>), [file formats](<https://fmind.github.io/brain-framework/docs/schema/index.md>), [link rules](<https://fmind.github.io/brain-framework/docs/link-reference/index.md>), the [retrieval reference](<https://fmind.github.io/brain-framework/docs/retrieval/index.md>) and [limits](<https://fmind.github.io/brain-framework/docs/limits/index.md>). |
| Resolve a problem | [Troubleshooting](<https://fmind.github.io/brain-framework/docs/troubleshooting/index.md>), [install and update](<https://fmind.github.io/brain-framework/docs/upgrades/index.md>) or the [changelog](<https://fmind.github.io/brain-framework/changelog/index.md>). |

## 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](<https://fmind.github.io/brain-framework/docs/privacy/index.md>) 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](<https://fmind.github.io/brain-framework/docs/upgrades/#match-the-docs-to-your-version>). Agents can read them as [Markdown](<https://fmind.github.io/brain-framework/docs/agents/#choose-how-your-agent-connects>).