create-hummingbird-app
v1.0.3
Published
A CLI tool to scaffold Hummingbird starter templates.
Downloads
107
Readme
A CLI tool to scaffold Hummingbird starter templates.
Installation
Using npm:
npx create-hummingbird-app@latestUsing pnpm:
pnpm create hummingbird-app@latestBasic usage
If you run the CLI without flags, it will guide you step-by-step:
npx create-hummingbird-app@latestYou will be prompted to:
- Enter your project name
- Choose your preferred Tailwind CSS setup method
- Choose JavaScript or TypeScript
You can also specify a folder name:
npx create-hummingbird-app@latest my-appSkip all prompts -y, --yes
Use defaults and setup the template instantly.
## installs default JavaScript template (vite-js)
npx create-hummingbird-app --yes
## installs default TypeScript template (vite-ts)
npx create-hummingbird-app --yes --tsSpecify a project directory:
npx create-hummingbird-app my-app --yesChoose a template directly -t, --template <name>
This bypasses all template-related prompts.
## choose a full explicit template
npx create-hummingbird-app --template vite-ts
## or choose a shorthand (CLI auto-detects JS/TS)
npx create-hummingbird-app -t vite
## shorthand + TypeScript
npx create-hummingbird-app -t vite --tsSpecify directory as well:
npx create-hummingbird-app -t vite-ts my-appForce TypeScript --ts
If you want TypeScript but still want interactive mode:
npx create-hummingbird-app --tsCombine with a project directory:
npx create-hummingbird-app my-app --tsFull help and reference -h, --help
Show help information, including all available flags and usage examples.
npx create-hummingbird-app --helpThis will output like this:
Usage: create-hummingbird-app [options] [project-name]
Arguments:
project-name optional project name
Options:
-V, --version output the version number
-y, --yes skip all prompts and use defaults
-t, --template <template> select template (vite-ts, vite-js, postcss-ts, postcss-js)
--ts force typescript template
-h, --help display help for commandTemplate Matrix
The following templates are available:
| Template Name | Build Tool | CLI Example |
|---------------|--------------------------------|--------------|
| vite-js | Vite + Vanilla JS | -t vite or -t vite-js |
| vite-ts | Vite + Vanilla JS (TypeScript) | -t vite --ts or -t vite-ts |
| postcss-js | PostCSS | -t postcss or -t postcss-js |
| postcss-ts | PostCSS (TypeScript) | -t postcss --ts or -t postcss-ts |
CLI Options
| Option | Alias | Description | Example |
|--------|--------|-------------|----------|
| --yes | -y | Skip all prompts and use default settings | npx create-hummingbird-app --yes |
| --template <name> | -t <name> | Select a specific template (supports shorthand or full name) | -t vite, -t vite-ts, -t vite --ts |
| --ts | — | Force TypeScript variant (when using shorthand templates or prompts) | npx create-hummingbird-app --ts |
| <project-name> | — | Optional project folder name | npx create-hummingbird-app my-app |
| --version | -V | Show the CLI version | npx create-hummingbird-app -V |
| --help | -h | Show help information | npx create-hummingbird-app -h |
About
Create Hummingbird App is the official project scaffolding tool for Hummingbird — a high-performance Tailwind-based UI framework.
