BunPress Documentation
⌘ K

CLI Commands Reference

BunPress provides a comprehensive command-line interface for managing your documentation projects. This guide covers all 15+ commands available.

Installation

After installing BunPress, the bunpress command is available globally:

bun add @stacksjs/bunpress
# or
npm install @stacksjs/bunpress

Command Overview

bunpress --help        # Show all available commands
bunpress --version     # Show BunPress version

Core Commands

init

Initialize a new BunPress documentation project with default structure and configuration.

Usage:

bunpress init [options]

Options:

  • --name - Project name (default: current directory name)
  • --template