Getting Started

brain.yaml

The optional config file created by brain project init. All fields have sensible defaults — you only need to edit what you want to change.

version: "1.0"

llm:
  provider: none          # none | openai | ollama | gemini | huggingface
  model: ""               # model name for chosen provider
  timeout_sec: 60

analysis:
  depth: fast             # analysis depth
  include_tests: false    # whether to scan test files
  ignore:
    - .brain/
    - .git/
    - node_modules/

diff:
  mode: function          # function | file

export:
  full_code:
    include_tests: false
    max_file_size_kb: 200
  manual_add:
    allow_duplicates: true
  changes:
    mode: function
    include_context: true
    output_path: .brain/exports/code_changes.txt

explain:
  level: detailed         # detailed | brief
  include_risks: true

output:
  format: text            # text | json | markdown

Key Settings

llm.provider

Set to none for fully offline mode. No API calls, no uploads.

analysis.ignore

Paths excluded from AST scanning. Add large generated dirs here.

diff.mode

function shows per-function changes; file shows file-level only.

output.format

Controls brain project summary output format.

Warning

Never store API keys in brain.yaml. Use environment variables only — see API Key Setup.

← Quick Start brain project init →