Bunary logo[bunary]

    Bunary is v0.x and under active development — APIs may still move between minor releases.

    Installation

    Get Bunary up and running in your project.

    Requirements

    Before installing Bunary, ensure you have the following prerequisites:

    • Bun v1.0 or later — Install Bun
    • TypeScript 5.0+ (included with Bun)

    Note: Bunary is designed specifically for the Bun runtime and will not work with Node.js.

    Quick Start with CLI

    The fastest way to get started is using the Bunary CLI:

    # Install the CLI globally
bun add -g @bunary/cli

# Create a new project
bunary init my-api

# Navigate to your project
cd my-api

# Install dependencies
bun install

# Start the development server
bun run dev

    This will create a new directory with a Bunary project scaffold including:

    • package.json — @bunary/core, @bunary/http; add --auth basic or --auth jwt to include @bunary/auth
    • bunary.config.ts — uses defineConfig from @bunary/core
    • src/index.ts — entry point; imports and calls registerRoutes from src/routes, then app.listen({ port: 3000 })
    • src/routes/ — main, groupExample, index; src/routes/index.ts defines and exports registerRoutes. Add more with bunary route:make <name>
    • With --auth — src/middleware/basic.ts or jwt.ts wired in the entrypoint

    Manual Installation

    If you prefer to set up Bunary manually or add it to an existing project:

    1. Install Packages

    Option A — Umbrella package (all-in-one):

    bun add bunary

    Then import from bunary or bunary/http, bunary/core, etc.

    Option B — Individual packages:

    bun add @bunary/core @bunary/http

    The steps below use @bunary/core and @bunary/http imports. If you installed the umbrella package, use bunary/core and bunary/http (or bunary for the main exports) instead.

    2. Create Configuration File

    Create a bunary.config.ts in your project root:

    import { createConfig, defineConfig } from "@bunary/core";

export const configStore = createConfig(
  defineConfig({
    app: {
      name: "My API",
      env: "development",
      debug: true,
    },
  }),
);

export default configStore.get();

    3. Create Entry Point

    Create your application entry point at src/index.ts:

    import { createApp } from "@bunary/http";

const app = createApp();

app.get("/", () => ({
  message: "Hello, Bunary!",
}));

app.get("/health", () => ({
  status: "ok",
  timestamp: new Date().toISOString(),
}));

const server = app.listen({ port: 3000 });
console.log(`🚀 Server running at http://localhost:${server.port}`);

    4. Run Your App

    bun run src/index.ts

    Optional Packages

    Add additional packages as needed:

    # Authentication support
bun add @bunary/auth

# CLI for development tools
bun add -D @bunary/cli

# ORM for database operations
bun add @bunary/orm

    Last updated