Neon CLI command: bootstrap

The bootstrap command scaffolds a new application from a Neon starter template. By default it runs interactively: it prompts you to pick a template, scaffolds it into the target directory, then offers the usual setup steps (install dependencies, initialize git, link the directory to a Neon project). Requires neon 2.25.0 or later; check your version with neon --version.

Usage

neon bootstrap [directory] [options]

The directory argument is optional. Use . to scaffold into the current directory, or leave it out and bootstrap prompts you for one. The target directory must be empty unless you pass --force.

Options

Option	Description	Type	Default	Required
`--agent`	Emit a JSON state-machine response designed for AI agents instead of prompting. The output is a single JSON object with a discriminated `status` field describing the next step.	boolean	`false`	No
`--default`, `-y`	Quick start: scaffold the default template (or --template) and run the usual setup (install dependencies, git init) without prompting. Linking is left to you since it needs a project choice.	boolean	`false`	No
`--force`	Scaffold into the target directory even if it is not empty (colliding files are overwritten).	boolean	`false`	No
`--git`	Initialize a git repository after scaffolding. In interactive mode this is offered as a prompt; use --no-git to skip without being asked.	boolean	`true`	No
`--install`	Install dependencies after scaffolding. In interactive mode this is offered as a prompt; use --no-install to skip without being asked.	boolean	`true`	No
`--link`	Run `neon link` in the scaffolded directory after installing. In interactive mode this is offered as a prompt; use --no-link to skip without being asked.	boolean	`true`	No
`--list-templates`, `--list`, `--ls`	List available templates and exit.	boolean	`false`	No
`--template`	Template to use (skips the interactive picker). Run with --list-templates to see available templates.	string	—	No

Run with --list-templates to see the available templates, and pass one with --template to skip the interactive picker.

The post-scaffold steps (--install, --git, --link) all default to on. In interactive mode, bootstrap asks about each one; use the negated form (--no-install, --no-git, --no-link) to skip a step without being asked. With --link, bootstrap runs neon link in the scaffolded directory after installing.

Use --default (alias -y) for a quick start: it scaffolds the default template (or the one you pass with --template) and runs dependency install and git init without prompting. Linking is left to you, since it needs a project choice.

Examples

Create ./my-app from an interactively chosen template:

neon bootstrap my-app

Scaffold a specific template into the current directory:

neon bootstrap . --template hono

Quick start: scaffold the default template and run setup without prompting:

neon bootstrap my-app --default

Agent mode

Pass --agent to skip the prompts and emit a JSON state-machine response designed for AI agents. The output is a single JSON object with a discriminated status field describing the next step.

neon bootstrap my-app --template hono --agent