BitaKit
Learn step by step

1. Create an app

Create a BitaKit app with npm, pnpm, Yarn or Bun, run it and check it, in four steps.

In about five minutes you will have a running Next.js app with BitaKit connected, one visible change of your own and a clean check. The next lessons grow a feature inside it.

You need Node.js 24 and one package manager: npm 10 or newer, pnpm, Yarn or Bun. Choose yours in any command block below; the docs remember the choice.

Create the project

npm create @bitakit/app@latest my-app -- --framework next --features none --yes

The generator creates my-app, connects BitaKit to Next.js and installs the dependencies with the package manager that ran it. --features none keeps this first app minimal; without the options it asks what to include and defaults to a complete frame (Shell, Settings and Quick Search). To use the folder you already have open, for example in a coding agent, write . instead of my-app.

Start it

cd my-app
npm run dev

Open the address the terminal prints. You see Welcome.

Make one change

Replace src/app/page.tsx with:

src/app/page.tsx
'use client';
import { PageHeader } from '@bitakit/ui/components';

export default function Home() {
  return <PageHeader title="My first app" />;
}

The page now says My first app. Leave the generated provider and configuration as they are.

Check the project

In a second terminal, in my-app:

npm run typecheck
npx bitakit doctor

typecheck generates the plugin types (src/bitakit.gen.*) and checks your code. doctor reports wiring problems with the fix. npx bitakit runs the CLI installed in the project with any package manager.

What you have

layout.tsx
page.tsx
[...path]/page.tsx
bitakit.gen.tsx
next.config.ts
AGENTS.md
FileJob
src/app/layout.tsxMounts the generated <BitaKitProvider> once
src/app/[...path]The catch-all route that renders plugin pages; your own routes stay normal Next.js
src/bitakit.gen.*Generated by discovery; never edit, never commit
next.config.tsWraps your config with withBitaKit
AGENTS.md, CLAUDE.mdOne screen of rules for coding agents, plus the BitaKit skill in .agents/skills/

Features go into src/plugins/<name>/. There is none yet.

Next

Other starting points

On this page