brakit/docs

Quick Start

See what your API is really doing. Zero config.

Brakit captures every HTTP request, database query, fetch call, console log, and error, then shows you everything in a live dashboard. Security scanning, N+1 detection, and performance insights happen automatically.

Install

Select your setup to see the installation steps.

Next.js terminal
$ npx brakit install
# auto-detects Next.js, creates instrumentation
$ npm run dev
# dashboard at localhost:<port>/__brakit
FastAPI terminal
$ pip install brakit
# in your main app file (e.g. main.py)
import brakit # must be first import
from fastapi import FastAPI
app = FastAPI()
$ uvicorn main:app --reload

Cross-service traces link automatically. Queries inside FastAPI nest under the fetch from Next.js.

Requirements: Node.js 18+ for the dashboard. Python 3.9+ for the Python SDK.

What You'll See

Open /__brakit on your dev server and interact with your app. Brakit captures everything in real time:

Brakit dashboard showing the Overview tab with requests, actions, queries, errors, and fetches

What Brakit Does

Security

8 rules scanned automatically: leaked secrets, PII in responses, tokens in URLs, stack traces, insecure cookies, and more.

Queries

Every database query captured with operation, table, duration, and row count. N+1 patterns flagged automatically.

Actions

Requests grouped by what the user did: "Sign Up", "Load Dashboard". Not raw HTTP noise.

Performance

Health grades, p95 trends, slow endpoint detection, and metrics that persist across sessions.

Tracing

Server-side fetch calls, console output, and unhandled errors, all correlated to the request that triggered them.

AI Integration

Via MCP, Claude Code and Cursor read issues, fix code, and verify the fix. The full detect, fix, verify loop.

Removing Brakit

npx brakit uninstall

Removes the instrumentation file and the brakit package. Your app goes back to exactly how it was.

Next Steps

  • CLI Commands : Install, uninstall, and telemetry commands
  • Architecture : How in-process hooks, analysis, and the dashboard work together
  • Security Rules : The 8 rules and what they catch
  • Adapters : How brakit captures database queries from pg, mysql2, and Prisma
  • MCP Integration : How AI assistants connect to brakit via the Model Context Protocol
Previous← PillarsNextArchitecture →