CLI Commands

Install, uninstall, and configure brakit from the command line.

brakit install

npx brakit install

Sets up brakit in your project. This command:

Auto-detects your framework (Next.js, Remix, Nuxt, Vite, Astro, Express, Fastify)
Adds brakit as a dev dependency
Creates a one-line instrumentation file for your framework

Framework-specific setup

Framework	Instrumentation file
Next.js	src/instrumentation.ts with register() export
Nuxt	server/plugins/brakit.ts
Remix / Generic	import "brakit" prepended to entry file

After installing, just start your dev server as usual:

npm run dev

Brakit hooks in automatically and serves the dashboard at /__brakit on the same port as your running app.

brakit uninstall

npx brakit uninstall

Removes the instrumentation file and uninstalls the brakit package from your project. Your app goes back to exactly how it was before installation.

brakit telemetry

brakit telemetry          # Show current status
brakit telemetry off      # Opt out
brakit telemetry on       # Opt back in

Manage anonymous telemetry. See the Telemetry page for full details on what is and isn't collected.

Environment Variables

Variable	Default	Description
BRAKIT_DISABLE	-	Set to "1" to force-disable brakit in any environment.
BRAKIT_TELEMETRY	true	Set to "false" to disable anonymous telemetry.

Brakit automatically disables itself in production environments by checking NODE_ENV and 15+ cloud/CI environment variables. You generally don't need to set BRAKIT_DISABLE manually.

Previous← Introduction NextArchitecture →