project-brain logoproject-brain

diff

brain diff explain

Explain a file or function

Stability:stable
Introduced:0.1.0

Syntax

brain diff explain [options]

Parameters

ArgumentTypeDefaultDescription
targetstrREQUIREDFile path or file:function target

Demo

brain diff explain
brain diff explain

Prerequisites

  • ✔brain testllm test

Consumes

📥 source code

Produces

📤 terminal explanation

Examples

brain diff explain src/main.py
brain diff explain src/main.py:function_name

Workflow

  1. 1
    brain project analyze
  2. 2
    brain diff explain

Use Cases

  • •Code Understanding
  • •Developer Onboarding
  • •Function Investigation

Target Personas

👤 developer👤 new contributor👤 reviewer

Notes

  • •Supports file-level and function-level explanation.

Edge Cases

  • •Function name must exist in file.

Related Commands

brain diff review
← brain diff reviewbrain export full-code →