CodeBrief

Instant codebase intelligence. Zero dependencies. One command.

Run codebrief in any project directory and instantly understand its tech stack, architecture, health, and activity — no configuration needed.

Install

# Run directly from GitHub (no install needed)
npx github:dev-sudeep018/codebrief

# Or install globally
npm install -g github:dev-sudeep018/codebrief
codebrief

What It Does

CodeBrief scans your project and generates a beautiful terminal report:

• Stack Detection — 35+ languages, 80+ frameworks automatically identified
• Architecture Map — Directory structure with inferred purposes
• Health Score — A–F grade based on best practices (tests, CI, types, docs, linting)
• Activity Summary — Contributors, commit history, project age
• Zero Config — Works on Node.js, Python, Rust, Go, Java, Ruby, and more
• Zero Dependencies — Pure Node.js, nothing to install but Node itself

Example Output

  ● CODEBRIEF
  Instant Codebase Intelligence

  my-app v2.1.0
  "A modern web application framework"
  /home/dev/projects/my-app
  342 files │ git │ 87 deps

  STACK ──────────────────────────────────────────

  TypeScript  ████████████████░░░░  74.2%  (234)
  JavaScript  ██████░░░░░░░░░░░░░░  21.3%  (67)
  Python      █░░░░░░░░░░░░░░░░░░░   4.5%  (14)

  Framework:  Next.js · React
  Styling:    Tailwind CSS
  Test:       Jest · Playwright
  Build:      Vite
  CI:         GitHub Actions
  ORM:        Prisma
  Database:   PostgreSQL

  ARCHITECTURE ────────────────────────────────────

  ├── src/        (187)  Source code
  ├── test/       (42)   Tests
  ├── prisma/     (3)    Prisma schema
  ├── docs/       (12)   Documentation
  ├── scripts/    (8)    Scripts
  └── public/     (15)   Static assets

  ACTIVITY ────────────────────────────────────────

  Branch: main  │  Commits: 847  │  Active: 5 contributors
  Last commit: 3 hours ago
  Project age: 1y 4m

  alice     ████████████████████  312 commits
  bob       ████████████░░░░░░░░  198 commits
  carol     ████████░░░░░░░░░░░░  134 commits

  HEALTH ──────────────────────────────────────────

  Score: 87/100  Grade: A
  ██████████████████████████░░░░  87%

  ✔ README
  ✔ Test suite
  ✔ CI/CD pipeline
  ✔ Type safety
  ✔ Linter configured
  ✔ License
  ✔ .gitignore
  ✔ Active development
  ✔ Documentation
  ✔ Package manager lock file
  ⚠ CONTRIBUTING.md
  ✗ Security policy
  ⚠ Editor config

  ────────────────────────────────────────────────
  Generated by CodeBrief — github.com/dev-sudeep018/codebrief

Supported Languages

JavaScript, TypeScript, Python, Rust, Go, Java, Kotlin, Scala, C#, F#, C, C++, Swift, PHP, Ruby, Dart, Lua, Julia, Elixir, Erlang, Haskell, OCaml, Elm, Clojure, Zig, Nim, Crystal, Perl, Groovy, Solidity, Shell, PowerShell, SQL, GraphQL, Protobuf, Terraform, and more.

Detected Frameworks & Tools

Frameworks: Next.js, Nuxt, SvelteKit, Remix, Astro, Gatsby, Angular, Django, Flask, FastAPI, Spring Boot, Ruby on Rails, Actix Web, Axum, Gin, Fiber, and more.

UI: React, Vue, Svelte, Solid, Preact, HTMX

Build: Vite, Webpack, esbuild, Rollup, Turbo

Test: Jest, Vitest, Mocha, Playwright, Cypress, pytest

ORM/DB: Prisma, Drizzle, TypeORM, Sequelize, SQLAlchemy, MongoDB, Redis, PostgreSQL

Infra/CI: Docker, Kubernetes, Terraform, GitHub Actions, GitLab CI, CircleCI

Lint: ESLint, Prettier, Biome, Ruff

ML/Data: PyTorch, TensorFlow, scikit-learn, Pandas, NumPy

Options

Usage:
  codebrief [path] [options]

Options:
  --json        Output raw JSON (for scripting/CI)
  --no-git      Skip git history analysis
  --no-color    Disable terminal colors
  -h, --help    Show help
  -v, --version Show version

Why CodeBrief?

	CodeBrief	cloc	tokei	onefetch
Language stats	Yes	Yes	Yes	Yes
Framework detection	80+	No	No	No
Architecture map	Yes	No	No	No
Health scoring	Yes	No	No	No
Contributor analysis	Yes	No	No	Basic
Zero dependencies	Yes	No	No	No
Zero config	Yes	Yes	Yes	Yes

Requirements

• Node.js >= 18
• Git (optional, for activity analysis)

License

MIT