Skip to content
v1.0.0-beta.8

Installation

Prerequisites

  • Bun v1.2.0 or later
Terminal window
bun --version # Verify your version

Basic Usage

Create a new project (interactive mode):

Terminal window
bun create harpia-app my-project
# or
bunx create-harpia-app my-project

Advanced Options

Project Type Selection

Choose during setup or specify directly:

Terminal window
# API-only project
bun create harpia-app my-api --api
# Fullstack project
bun create harpia-app my-app --fullstack

Frontend Options (for fullstack projects)

Add flags to skip interactive prompts:

Terminal window
# With Tailwind + HTMX
bun create harpia-app my-app --fullstack --tailwind --htmx
# With Alpine.js
bun create harpia-app my-app --fullstack --alpine
# All frontend options
bun create harpia-app my-app --fullstack --tailwind --alpine --htmx

Available Flags

FlagDescriptionValid With
--apiCreates API-only project
--fullstackCreates fullstack project
--tailwindAdds Tailwind CSS--fullstack
--alpineAdds Alpine.js--fullstack
--htmxAdds HTMX--fullstack

After Creation

Terminal window
cd my-project
bun dev

Your app will run at http://localhost:3000