{
  "inkcap": 1,
  "name": "brainfile",
  "tagline": "markdown task boards for you and your agents",
  "description": "Markdown task boards for you and your coding agents. Every task, epic, plan and decision is a plain Markdown file in your repo; you work the board from a CLI or a TUI, and your agents work it through an MCP server.",
  "url": "https://brainfile.md",
  "repo": "https://github.com/1broseidon/brainfile",
  "version": "v0.22.0",
  "license": "MIT",
  "language": "JavaScript",
  "updated": "2026-10-12",
  "install": {
    "command": "npm install -g brainfile\nbrainfile init",
    "page": "https://brainfile.md/#install"
  },
  "agent": "Install brainfile and set up a board in this repo for me.\n1. Run: npm install -g brainfile\n2. Run `brainfile init` at the repo root.\n3. Add the MCP server to .mcp.json:\n   {\"mcpServers\":{\"brainfile\":{\"command\":\"npx\",\"args\":[\"brainfile\",\"mcp\"]}}}\n4. Run `brainfile brief --agent <your name>` and tell me what the board says.\nFrom here on, track work on the board: `brainfile add` before you start,\n`brainfile note` as you learn things, `brainfile complete` when you are done.",
  "manual": {
    "html": "https://brainfile.md/",
    "markdown": "https://brainfile.md/llms-full.txt",
    "index": "https://brainfile.md/llms.txt"
  },
  "changelog": "https://brainfile.md/changelog/",
  "sections": [
    {
      "id": "overview",
      "label": "Overview",
      "summary": "A board is a .brainfile/ directory next to your code.",
      "url": "https://brainfile.md/#overview"
    },
    {
      "id": "install",
      "label": "Install",
      "summary": "brainfile is an npm package; it needs Node 20 or newer.",
      "url": "https://brainfile.md/#install"
    },
    {
      "id": "quickstart",
      "label": "Quickstart",
      "summary": "The session below is real output from 0.20.0, run in an empty directory.",
      "url": "https://brainfile.md/#quickstart"
    },
    {
      "id": "the-board-on-disk",
      "label": "The board on disk",
      "summary": "Three kinds of file, all Markdown with YAML frontmatter, all meant to be read and edited by hand when that is quicker than a command.",
      "url": "https://brainfile.md/#the-board-on-disk"
    },
    {
      "id": "choosing-a-command",
      "label": "Choosing a command",
      "url": "https://brainfile.md/#choosing-a-command"
    },
    {
      "id": "commands",
      "label": "Commands",
      "summary": "Thirty-six commands, in four groups.",
      "url": "https://brainfile.md/#commands"
    },
    {
      "id": "contracts",
      "label": "Contracts",
      "summary": "A contract is the part of a task an agent is accountable for: what files to produce, what commands must pass, and what rules to respect.",
      "url": "https://brainfile.md/#contracts"
    },
    {
      "id": "sharing-a-board",
      "label": "Sharing a board",
      "summary": "While two boards disagree, every write (from the CLI or an agent's MCP tools) is refused with that same sentence and the command that settles it; reading still works.",
      "url": "https://brainfile.md/#sharing-a-board"
    },
    {
      "id": "related-boards",
      "label": "Related boards",
      "summary": "Work often spans repositories: an app and its mobile client, a service and its SDK.",
      "url": "https://brainfile.md/#related-boards"
    },
    {
      "id": "the-tui",
      "label": "The TUI",
      "summary": "brainfile tui opens the board in the terminal: columns across, a detail view for the selected document, and a filter line.",
      "url": "https://brainfile.md/#the-tui"
    },
    {
      "id": "for-agents",
      "label": "For agents",
      "summary": "The board is a directory of Markdown, so any agent that can read files can read it.",
      "url": "https://brainfile.md/#for-agents"
    },
    {
      "id": "notes",
      "label": "Notes",
      "summary": "Every task is its own file so that a task's history is its git history and a merge touches one small file at a time.",
      "url": "https://brainfile.md/#notes"
    }
  ],
  "commands": [
    {
      "name": "init",
      "summary": "Create .brainfile/ in the current directory",
      "url": "https://brainfile.md/#init"
    },
    {
      "name": "list",
      "summary": "List tasks, optionally filtered",
      "url": "https://brainfile.md/#list"
    },
    {
      "name": "show",
      "summary": "Full details of one task",
      "url": "https://brainfile.md/#show"
    },
    {
      "name": "add",
      "summary": "Create a document",
      "url": "https://brainfile.md/#add"
    },
    {
      "name": "move",
      "summary": "Change a task's column",
      "url": "https://brainfile.md/#move"
    },
    {
      "name": "patch",
      "summary": "Partial update of a task's fields",
      "url": "https://brainfile.md/#patch"
    },
    {
      "name": "complete",
      "summary": "Finish a task",
      "url": "https://brainfile.md/#complete"
    },
    {
      "name": "delete",
      "summary": "Remove a task permanently",
      "url": "https://brainfile.md/#delete"
    },
    {
      "name": "subtask",
      "summary": "Add, toggle, update or delete subtasks",
      "url": "https://brainfile.md/#subtask"
    },
    {
      "name": "search",
      "summary": "Search the board, its history and the project's docs",
      "url": "https://brainfile.md/#search"
    },
    {
      "name": "note",
      "summary": "Append a timestamped line to a task's log",
      "url": "https://brainfile.md/#note"
    },
    {
      "name": "log",
      "summary": "Read completed work",
      "url": "https://brainfile.md/#log"
    },
    {
      "name": "tui",
      "summary": "The interactive board",
      "url": "https://brainfile.md/#tui"
    },
    {
      "name": "brief",
      "summary": "Decisions, your tasks, what changed, the docs that bear on them",
      "url": "https://brainfile.md/#brief"
    },
    {
      "name": "contract",
      "summary": "pickup, deliver, validate, attach, graph, activate",
      "url": "https://brainfile.md/#contract"
    },
    {
      "name": "mcp",
      "summary": "Start the MCP server",
      "url": "https://brainfile.md/#mcp"
    },
    {
      "name": "hooks",
      "summary": "Install reminder hooks into a coding agent",
      "url": "https://brainfile.md/#hooks"
    },
    {
      "name": "plan",
      "summary": "First-class plan documents",
      "url": "https://brainfile.md/#plan"
    },
    {
      "name": "decide, supersede, retire",
      "summary": "Decisions",
      "url": "https://brainfile.md/#decide-supersede-retire"
    },
    {
      "name": "check",
      "summary": "Does a decision still hold?",
      "url": "https://brainfile.md/#check"
    },
    {
      "name": "columns",
      "summary": "Add, rename, reorder and remove columns",
      "url": "https://brainfile.md/#columns"
    },
    {
      "name": "types",
      "summary": "Every type and its place in the graph",
      "url": "https://brainfile.md/#types"
    },
    {
      "name": "template",
      "summary": "Create tasks from templates",
      "url": "https://brainfile.md/#template"
    },
    {
      "name": "lint",
      "summary": "Validate the config, fix what it can",
      "url": "https://brainfile.md/#lint"
    },
    {
      "name": "index",
      "summary": "The local search index",
      "url": "https://brainfile.md/#index"
    },
    {
      "name": "schema",
      "summary": "The bundled JSON Schemas",
      "url": "https://brainfile.md/#schema"
    },
    {
      "name": "migrate",
      "summary": "Upgrade a v1 board, or change how it is stored",
      "url": "https://brainfile.md/#migrate"
    },
    {
      "name": "where",
      "summary": "Where the board lives and who has it",
      "url": "https://brainfile.md/#where"
    },
    {
      "name": "adopt, merge-boards, backups",
      "summary": "Settle two boards into one",
      "url": "https://brainfile.md/#adopt-merge-boards-backups"
    },
    {
      "name": "sync",
      "summary": "Share a board through a git remote",
      "url": "https://brainfile.md/#sync"
    },
    {
      "name": "archive, restore",
      "summary": "Export completed work, or bring it back",
      "url": "https://brainfile.md/#archive-restore"
    },
    {
      "name": "auth",
      "summary": "GitHub and Linear credentials",
      "url": "https://brainfile.md/#auth"
    },
    {
      "name": "config",
      "summary": "The user-level config file",
      "url": "https://brainfile.md/#config"
    }
  ]
}