# Brain Framework

> 🧠 Brain Framework: from information to informed actions.

Brain Framework (`bf`) keeps a brain in plain files: collection, validation, a knowledge graph and offline retrieval for people and agents. Release notes and upgrade steps are in the [changelog](https://raw.githubusercontent.com/fmind/brain-framework/main/CHANGELOG.md).

## Start here

- [Overview](<https://fmind.github.io/brain-framework/docs/index.md>): Keep evidence, decisions and next steps in plain files that you and your agents search, read and connect.
- [Getting started](<https://fmind.github.io/brain-framework/docs/getting-started/index.md>): Create a brain, save your first project decision, search its reason and verify the result.
- [Four-tool walkthrough](<https://fmind.github.io/brain-framework/docs/context-hub/index.md>): Run a fictional four-tool example that collects evidence, records a conclusion and flags it when a source changes.
- [Core concepts](<https://fmind.github.io/brain-framework/docs/concepts/index.md>): Understand projects, records, concepts and actions, the flow from evidence to decisions, and the terms BF uses.
- [Install and update](<https://fmind.github.io/brain-framework/docs/upgrades/index.md>): Install or update Brain Framework, match documentation to your version and verify the result.

## Guides

- [Write notes and actions](<https://fmind.github.io/brain-framework/docs/brain/index.md>): Write project notes, reusable concepts and resumable actions with complete Markdown examples.
- [Search and read](<https://fmind.github.io/brain-framework/docs/search/index.md>): Find saved evidence, read exact sources and check whether results are complete.
- [Linking knowledge](<https://fmind.github.io/brain-framework/docs/links/index.md>): Connect notes and records with citations, typed fields, explicit identities and declared relations.
- [Check your brain](<https://fmind.github.io/brain-framework/docs/checks/index.md>): Validate saved files and test that recurring questions still retrieve the expected evidence.
- [Add a sensor](<https://fmind.github.io/brain-framework/docs/sensors/index.md>): Collect a selected local document or highlight, configure sensors and understand update and replacement rules.
- [Run routines](<https://fmind.github.io/brain-framework/docs/routines/index.md>): Run deterministic brain programs now, on a schedule or from Git hooks, and turn their output into logs or review actions.
- [Run prompts](<https://fmind.github.io/brain-framework/docs/prompts/index.md>): Run your agent harness over the brain on a schedule or on demand, and keep every run as a record it reads back.
- [Watch and schedule updates](<https://fmind.github.io/brain-framework/docs/schedule/index.md>): Run or observe due sensors, routines and prompts, set watch preferences and generate native schedules.
- [Agent workflows](<https://fmind.github.io/brain-framework/docs/agents/index.md>): Use the CLI, the packaged skills and optional hooks to find evidence and keep agent work resumable.
- [Connect an agent with MCP](<https://fmind.github.io/brain-framework/docs/mcp/index.md>): Connect an agent through local MCP search and read tools, then verify access to a saved decision.
- [Team setup](<https://fmind.github.io/brain-framework/docs/team/index.md>): Set up a private team brain, share reviewed evidence, coordinate collection and evaluate a pilot.

## Reference

- [Commands](<https://fmind.github.io/brain-framework/docs/commands/index.md>): Look up Brain Framework commands, previews, graph exports, replies, errors and exit codes.
- [Configuration](<https://fmind.github.io/brain-framework/docs/configuration/index.md>): Configure a brain, choose which brains a command uses, declare related brains and locate local state.
- [Notes, records and fields](<https://fmind.github.io/brain-framework/docs/schema/index.md>): Exact formats of bf.yaml, notes, records, shared fields and sensor mappings, with editor validation.
- [Links and tags](<https://fmind.github.io/brain-framework/docs/link-reference/index.md>): Exact rules for BF addresses, section anchors, identities, relation links and tags.
- [Retrieval](<https://fmind.github.io/brain-framework/docs/retrieval/index.md>): Reply fields and rules for search, read, pages, relation pages, continuations and MCP clients.
- [Limits and safeguards](<https://fmind.github.io/brain-framework/docs/limits/index.md>): Look up size, page and process limits, and the safeguards around running programs.
- [Troubleshooting](<https://fmind.github.io/brain-framework/docs/troubleshooting/index.md>): Diagnose installation, retrieval, collection and file problems without losing evidence.

## Privacy and legal

- [Privacy and security](<https://fmind.github.io/brain-framework/docs/privacy/index.md>): Understand local storage, cloud-agent boundaries, program execution and audience separation.