create-needle

A CLI for creating spatial web projects powered by Needle Engine.

Quick Start

npm create needle

Usage

Interactive Mode

Run without arguments to be prompted for options:

npm create needle
# or
npx create-needle
# or
bunx create-needle

One-shot Mode

Specify options directly via CLI flags:

npm create needle my-project --template vite
npm create needle my-project -t react
npm create needle . --template vite

When running in a non-interactive environment, pass --template so the CLI can skip the prompt flow:

npm create needle my-project --template vite

Options

| Flag | Alias | Description | |------|-------|-------------| | --template <key> | -t | Template to use (see below) | | --engine <version> | -e | Needle Engine version to install | | --list | -l | List available templates as JSON | | --force | -f | Overwrite existing directory | | --help | -h | Show help |

Templates

Available templates:

• vite — HTML, CSS, JavaScript with Vite
• svelte — Svelte
• sveltekit — SvelteKit
• react — React
• react-three-fiber — R3F (react-three-fiber)

Examples

# Create in current directory (interactive)
npm create needle
# or
npx create-needle

# Create in specific directory
npm create needle my-app

# Use specific template
npm create needle my-app --template sveltekit

# Use specific Needle Engine version
npm create needle my-app --engine 4.14.0

# List available templates
npm create needle --list

# With bun
bun create needle
# or
bunx create-needle

Learn More

Needle Engine Documentation