# nabilkhan-01/brieflook architecture

> Architecture diagram of the GitHub repository nabilkhan-01/brieflook, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nabilkhan-01/brieflook
- Repository: https://github.com/nabilkhan-01/brieflook

## Overview

BriefLook is an offline repository-understanding CLI. Its scan workflow indexes a repository, detects onboarding and architecture facts, then presents a compact report; its separate impact command builds import relationships and traces reverse dependents. The graph preserves documented capability areas even where implementation excerpts were incomplete. Edges are limited to calls visible in the CLI excerpt or SOURCE INDEX references, plus README-documented behavior; some detector-to-data flow is therefore not drawn.

Main entry points: [`src/brieflook/cli/main.py`](https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/cli/main.py) (CLI Commands), [`src/brieflook/workspace/detector.py`](https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/workspace/detector.py) (Workspace Detection), [`src/brieflook/importgraph/builder.py`](https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/importgraph/builder.py) (Import Graph Builder), [`src/brieflook/dependencies/detector.py`](https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/dependencies/detector.py) (Module Dependencies)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_interface["CLI and Reports"]
  node_cli["CLI Commands<br/>[main.py]"]
end

subgraph group_onboarding["Repository Onboarding"]
  node_index[("Repository Index<br/>[index.py]")]
  node_workspace["Workspace Detection<br/>[detector.py]"]
  node_identity["Project Identity<br/>[detector.py]"]
  node_quickstart["Prerequisites<br/>[detector.py]"]
  node_environment["Environment Setup<br/>[detector.py]"]
  node_startdocs["Start Here<br/>[detector.py]"]
  node_entrypoints["Entry Points<br/>[detector.py]"]
  node_run["Run Guide<br/>[detector.py]"]
  node_structure["Project Structure<br/>[detector.py]"]
end

subgraph group_architecture["Architecture Analysis"]
  node_importbuilder["Import Graph Builder<br/>[builder.py]"]
  node_pythonparser["Python Import Parser<br/>[parser.py]"]
  node_jsparser["JS TS Parser"]
  node_dependencies["Module Dependencies<br/>[detector.py]"]
  node_cycles["Package Cycles<br/>[cycle_detector.py]"]
  node_assembly["Container Assembly<br/>[detector.py]"]
  node_boundary["Boundary Rules<br/>[boundary.py]"]
end

subgraph group_impact["Change Impact"]
  node_impactanalyzer["Impact Analyzer<br/>[analyzer.py]"]
end

node_developer(("Developer"))

node_developer -->|"runs commands"| node_cli
node_cli -->|"builds index"| node_index
node_cli -->|"detects workspace"| node_workspace
node_cli -->|"detects identity"| node_identity
node_cli -->|"detects prerequisites"| node_quickstart
node_cli -->|"detects environment"| node_environment
node_cli -->|"detects entry points"| node_entrypoints
node_cli -->|"detects run guide"| node_run
node_cli -->|"detects structure"| node_structure
node_cli -->|"detects assembly"| node_assembly
node_cli -->|"detects dependencies"| node_dependencies
node_cli -->|"detects package cycles"| node_cycles
node_cli -->|"builds import graph"| node_importbuilder
node_cli -->|"analyzes impact"| node_impactanalyzer
node_importbuilder -->|"uses parser"| node_pythonparser
node_importbuilder -->|"uses parser"| node_jsparser
node_dependencies -.->|"applies boundaries"| node_boundary
node_cli -.->|"reports start files"| node_startdocs
node_workspace -->|"filters members"| node_quickstart
node_workspace -->|"filters members"| node_entrypoints
node_workspace -->|"selects scripts"| node_run
node_workspace -->|"defines boundaries"| node_dependencies
node_importbuilder -->|"supplies graph"| node_impactanalyzer
node_importbuilder -->|"supplies imports"| node_dependencies
node_cli -->|"reports dependents"| node_impactanalyzer

click node_cli "https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/cli/main.py"
click node_index "https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/core/index.py"
click node_workspace "https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/workspace/detector.py"
click node_identity "https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/project/detector.py"
click node_quickstart "https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/quickstart/detector.py"
click node_environment "https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/environment/detector.py"
click node_startdocs "https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/readme/detector.py"
click node_entrypoints "https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/entrypoints/detector.py"
click node_run "https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/run/detector.py"
click node_structure "https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/structure/detector.py"
click node_importbuilder "https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/importgraph/builder.py"
click node_pythonparser "https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/importgraph/parser.py"
click node_jsparser "https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/importgraph/javascript_parser.py"
click node_dependencies "https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/dependencies/detector.py"
click node_cycles "https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/dependencies/cycle_detector.py"
click node_assembly "https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/assembly/detector.py"
click node_impactanalyzer "https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/impact/analyzer.py"
click node_boundary "https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/core/boundary.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli toneBlue
class node_index,node_workspace,node_identity,node_quickstart,node_environment,node_startdocs,node_entrypoints,node_run,node_structure toneAmber
class node_importbuilder,node_pythonparser,node_jsparser,node_dependencies,node_cycles,node_assembly,node_boundary toneMint
class node_impactanalyzer toneRose
class node_developer toneIndigo
```

## Components

### CLI and Reports

- [CLI Commands](https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/cli/main.py): `src/brieflook/cli/main.py`

### Repository Onboarding

- [Repository Index](https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/core/index.py): `src/brieflook/core/index.py`
- [Workspace Detection](https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/workspace/detector.py): `src/brieflook/workspace/detector.py`
- [Project Identity](https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/project/detector.py): `src/brieflook/project/detector.py`
- [Prerequisites](https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/quickstart/detector.py): `src/brieflook/quickstart/detector.py`
- [Environment Setup](https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/environment/detector.py): `src/brieflook/environment/detector.py`
- [Start Here](https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/readme/detector.py): `src/brieflook/readme/detector.py`
- [Entry Points](https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/entrypoints/detector.py): `src/brieflook/entrypoints/detector.py`
- [Run Guide](https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/run/detector.py): `src/brieflook/run/detector.py`
- [Project Structure](https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/structure/detector.py): `src/brieflook/structure/detector.py`

### Architecture Analysis

- [Import Graph Builder](https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/importgraph/builder.py): `src/brieflook/importgraph/builder.py`
- [Python Import Parser](https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/importgraph/parser.py): `src/brieflook/importgraph/parser.py`
- [JS TS Parser](https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/importgraph/javascript_parser.py): `src/brieflook/importgraph/javascript_parser.py`
- [Module Dependencies](https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/dependencies/detector.py): `src/brieflook/dependencies/detector.py`
- [Package Cycles](https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/dependencies/cycle_detector.py): `src/brieflook/dependencies/cycle_detector.py`
- [Container Assembly](https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/assembly/detector.py): `src/brieflook/assembly/detector.py`
- [Boundary Rules](https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/core/boundary.py): `src/brieflook/core/boundary.py`

### Change Impact

- [Impact Analyzer](https://github.com/nabilkhan-01/brieflook/blob/main/src/brieflook/impact/analyzer.py): `src/brieflook/impact/analyzer.py`

### Other components

- **Developer**

## Connections

- Developer → CLI Commands: runs commands
- CLI Commands → Repository Index: builds index (evidence: `src/brieflook/cli/main.py`)
- CLI Commands → Workspace Detection: detects workspace (evidence: `src/brieflook/cli/main.py`)
- CLI Commands → Project Identity: detects identity (evidence: `src/brieflook/cli/main.py`)
- CLI Commands → Prerequisites: detects prerequisites (evidence: `src/brieflook/cli/main.py`)
- CLI Commands → Environment Setup: detects environment (evidence: `src/brieflook/cli/main.py`)
- CLI Commands → Entry Points: detects entry points (evidence: `src/brieflook/cli/main.py`)
- CLI Commands → Run Guide: detects run guide (evidence: `src/brieflook/cli/main.py`)
- CLI Commands → Project Structure: detects structure (evidence: `src/brieflook/cli/main.py`)
- CLI Commands → Container Assembly: detects assembly (evidence: `src/brieflook/cli/main.py`)
- CLI Commands → Module Dependencies: detects dependencies (evidence: `src/brieflook/cli/main.py`)
- CLI Commands → Package Cycles: detects package cycles (evidence: `src/brieflook/cli/main.py`)
- CLI Commands → Import Graph Builder: builds import graph (evidence: `src/brieflook/cli/main.py`)
- CLI Commands → Impact Analyzer: analyzes impact (evidence: `src/brieflook/cli/main.py`)
- Import Graph Builder → Python Import Parser: uses parser (evidence: `src/brieflook/importgraph/builder.py`)
- Import Graph Builder → JS TS Parser: uses parser (evidence: `src/brieflook/importgraph/builder.py`)
- Module Dependencies → Boundary Rules: applies boundaries
- CLI Commands → Start Here: reports start files
- Workspace Detection → Prerequisites: filters members (evidence: `src/brieflook/quickstart/detector.py`)
- Workspace Detection → Entry Points: filters members (evidence: `src/brieflook/entrypoints/detector.py`)
- Workspace Detection → Run Guide: selects scripts (evidence: `src/brieflook/run/detector.py`)
- Workspace Detection → Module Dependencies: defines boundaries (evidence: `src/brieflook/dependencies/detector.py`)
- Import Graph Builder → Impact Analyzer: supplies graph (evidence: `src/brieflook/cli/main.py`)
- Import Graph Builder → Module Dependencies: supplies imports (evidence: `src/brieflook/cli/main.py`)
- CLI Commands → Impact Analyzer: reports dependents (evidence: `src/brieflook/cli/main.py`)
