Installation

BurgerAPI runs on Bun.js. You need Bun installed first.

Prerequisites

• Bun — Install from the official Bun installation guide. Verify with:

  bun --version

Install the Burger API CLI (recommended)

The CLI is the easiest way to create and run projects.

Option 1: Global install with Bun

bun add -g @burger-api/cli

Option 2: Use bunx (no global install)

bunx @burger-api/cli create my-project

Option 3: Standalone executable

• macOS / Linux / WSL:

  curl -fsSL https://burger-api.com/install.sh | bash

• Windows PowerShell:

  irm https://burger-api.com/install.ps1 | iex

You can also download binaries from GitHub Releases.

Create and run a project

burger-api create my-awesome-api
cd my-awesome-api
bun run dev

For full CLI options and manual setup, see the Getting Started Installation guide and the CLI Tool reference.