CLI Reference

This page covers all available command-line flags for React Kickstart. If you prefer the interactive experience (which is frankly recommended), just run the command without flags and you'll be guided through prompts.

But if you need to automate project generation (like in CI/CD) or prefer to configure everything upfront, these flags let you do exactly that.

Mix and match them to create your ideal setup.

Usage

npx @gavbarosee/react-kickstart <project-name> [options]

Core Options

--yes, -y — Skip prompts, use defaults

--framework <framework>, -f — Options: vite, nextjs

--typescript — Enable TypeScript

--no-typescript — Explicitly disable TypeScript

Styling

--styling <option> — Options: tailwind, styled-components, css

Routing

Vite: --routing react-router or --routing none

Next.js: --next-routing app or --next-routing pages

State Management

--state <option> — Options: redux, zustand, none

API Integration

--api <option> — Options: axios-react-query, fetch-react-query, axios-only, fetch-only, none

Testing

--testing <option> — Options: vitest, jest, none

Deployment

--deployment <option> — Options: vercel, netlify, none

Development Options

--package-manager <manager> — Options: npm, yarn (auto-detected)

--editor <choice> — Options: cursor, vscode, none — Open project in editor after generation

--no-editor — Skip opening editor after generation

--no-git — Skip Git initialization

--no-linting — Skip ESLint and Prettier

--skip-install — Don't install dependencies

--no-autostart — Don't start dev server

--no-summary — Skip pre-generation confirmation summary prompt

Help

--help, -h — Show help

--version, -v — Show version

Examples

Full Vite app:

npx @gavbarosee/react-kickstart my-vite-app \
  --yes \
  --framework vite \
  --typescript \
  --styling tailwind \
  --routing react-router \
  --state redux \
  --api axios-react-query \
  --testing vitest \
  --deployment netlify

Next.js production app:

npx @gavbarosee/react-kickstart my-nextjs-app \
  --yes \
  --framework nextjs \
  --typescript \
  --styling styled-components \
  --next-routing app \
  --state zustand \
  --api fetch-react-query \
  --testing jest \
  --deployment vercel

Minimal setup:

npx @gavbarosee/react-kickstart learning-react \
  --yes \
  --framework vite \
  --styling css \
  --routing none \
  --state none \
  --api none \
  --testing none