CLI

Create Hummingbird App

The Hummingbird CLI is a fast and flexible tool to quickly scaffold a new starter project using Hummingbird and Tailwind CSS. It provides interactive prompts or flags to customize the setup and create a ready-to-use project in seconds.

Installation

npx create-hummingbird-app@latest [project-name] [options]

Basic usage

If you run the CLI without flags, it will guide you step-by-step:

npx create-hummingbird-app

You will be prompted to:

1. Enter your project name
2. Choose your preferred Tailwind CSS setup method
3. Choose JavaScript or TypeScript

You can also specify a folder name:

npx create-hummingbird-app my-app

Skip 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 --ts

Specify a project directory:

npx create-hummingbird-app my-app --yes

Choose 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 --ts

Specify a directory as well:

npx create-hummingbird-app -t vite-ts my-app

Force TypeScript --ts

If you want TypeScript but still want interactive mode:

npx create-hummingbird-app --ts

Combine with a project directory:

npx create-hummingbird-app my-app --ts

Full help and reference -h, --help

Show help information, including all available flags and usage examples.

npx create-hummingbird-app --help

This 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 command

Template Matrix

The following templates are available:

CLI Options