Getting Started

Bklar is designed to be up and running instantly. The best way to start a new project is using our official CLI tool.

Automatic Installation

We recommend using bun create to scaffold your project. It provides interactive templates for different use cases.

Open your terminal and run:

bun create bklar my-app

The interactive wizard will ask you to choose a template:

Navigate to your new project and start the server:

cd my-app
bun run dev

Your server will be listening at http://localhost:3000.

If you prefer to build from scratch, you can install the core package manually.

bun add bklar zod

npm install bklar zod

pnpm add bklar zod

Note: zod is a required peer dependency for validation.

Create an index.ts file:

import { Bklar } from "bklar";

const app = Bklar();

app.get("/", (ctx) => {
  return ctx.text("Hello from Bklar! 🐰");
});

app.listen(3000);