Quick Start

Get a BurgerAPI app running in under a minute.

Prerequisites

• Bun — BurgerAPI is built for Bun. Install it from bun.sh.

Steps

1. Install the CLI (if you have Bun):

   bun add -g @burger-api/cli

   Or use bunx without installing:

   bunx @burger-api/cli create my-app

2. Create a project:

   burger-api create my-app

3. Enter the project and start the dev server:

   cd my-app
   bun run dev

4. Open http://localhost:4000 in your browser.

Next steps

• Installation — Full install options (standalone executable, manual setup).
• CLI Tool — All CLI commands (create, add, list, serve, build, build:exec).
• Configuration — Configure the Burger instance (apiDir, middleware, OpenAPI).