Volt CLI - Volt Documentation

Install the CLI

The executable is provided by @voltts/cli. Run it through Bun:

bash

bun add --dev @voltts/cli
bunx --bun --package @voltts/cli volt --help

Scaffold and run

Choose the modular API or minimal template in the terminal. For non-interactive use, pass --template api or --template minimal.

bash

bunx --bun --package @voltts/cli volt new my-api --template api
cd my-api
bun install
bun run dev

Supported commands

Command	Behavior
volt new name	Creates a project directory with src/index.ts and package scripts
volt dev src/index.ts	Starts Bun watch mode
volt routes src/app.ts	Imports the file and prints registered routes
volt version	Prints the CLI version
volt help	Prints command help

Inspect routes without starting a server

Route inspection imports your entry module. Export an app and guard listen with globalThis._importMeta_.main, as in Quick Start, to prevent side effects during inspection. The current executable has no build or generator commands; use Bun directly for bundling and write modules as shown in Modular Architecture.