How nabilkhan-01/brieflook works
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: main.py CLI Commands · workspace/detector.py Workspace Detection · builder.py Import Graph Builder · dependencies/detector.py Module Dependencies
Components 19
CLI and Reports
- CLI Commands
src/brieflook/cli/main.py
Repository Onboarding
- Repository Index
src/brieflook/core/index.py - Workspace Detection
src/brieflook/workspace/detector.py - Project Identity
src/brieflook/project/detector.py - Prerequisites
src/brieflook/quickstart/detector.py - Environment Setup
src/brieflook/environment/detector.py - Start Here
src/brieflook/readme/detector.py - Entry Points
src/brieflook/entrypoints/detector.py - Run Guide
src/brieflook/run/detector.py - Project Structure
src/brieflook/structure/detector.py
Architecture Analysis
- Import Graph Builder
src/brieflook/importgraph/builder.py - Python Import Parser
src/brieflook/importgraph/parser.py - JS TS Parser
src/brieflook/importgraph/javascript_parser.py - Module Dependencies
src/brieflook/dependencies/detector.py - Package Cycles
src/brieflook/dependencies/cycle_detector.py - Container Assembly
src/brieflook/assembly/detector.py - Boundary Rules
src/brieflook/core/boundary.py
Change Impact
- Impact Analyzer
src/brieflook/impact/analyzer.py
Other components
- Developer
Connections 25
- Developer → CLI Commands: runs commands
- CLI Commands → Repository Index: builds index
src/brieflook/cli/main.py - CLI Commands → Workspace Detection: detects workspace
src/brieflook/cli/main.py - CLI Commands → Project Identity: detects identity
src/brieflook/cli/main.py - CLI Commands → Prerequisites: detects prerequisites
src/brieflook/cli/main.py - CLI Commands → Environment Setup: detects environment
src/brieflook/cli/main.py - CLI Commands → Entry Points: detects entry points
src/brieflook/cli/main.py - CLI Commands → Run Guide: detects run guide
src/brieflook/cli/main.py - CLI Commands → Project Structure: detects structure
src/brieflook/cli/main.py - CLI Commands → Container Assembly: detects assembly
src/brieflook/cli/main.py - CLI Commands → Module Dependencies: detects dependencies
src/brieflook/cli/main.py - CLI Commands → Package Cycles: detects package cycles
src/brieflook/cli/main.py - CLI Commands → Import Graph Builder: builds import graph
src/brieflook/cli/main.py - CLI Commands → Impact Analyzer: analyzes impact
src/brieflook/cli/main.py - Import Graph Builder → Python Import Parser: uses parser
src/brieflook/importgraph/builder.py - Import Graph Builder → JS TS Parser: uses parser
src/brieflook/importgraph/builder.py - Module Dependencies → Boundary Rules: applies boundaries
- CLI Commands → Start Here: reports start files
- Workspace Detection → Prerequisites: filters members
src/brieflook/quickstart/detector.py - Workspace Detection → Entry Points: filters members
src/brieflook/entrypoints/detector.py - Workspace Detection → Run Guide: selects scripts
src/brieflook/run/detector.py - Workspace Detection → Module Dependencies: defines boundaries
src/brieflook/dependencies/detector.py - Import Graph Builder → Impact Analyzer: supplies graph
src/brieflook/cli/main.py - Import Graph Builder → Module Dependencies: supplies imports
src/brieflook/cli/main.py - CLI Commands → Impact Analyzer: reports dependents
src/brieflook/cli/main.py