CLI Reference

Complete reference for all React Kickstart CLI commands, flags, and options.

Basic Usage

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

Core Flags

`--yes, -y`

Skip all interactive prompts and use default values.

npx @gavbarosee/react-kickstart my-app --yes

Perfect for CI/CD - Ensures consistent, reproducible builds without user interaction.

`--framework <framework>`

Choose your React framework.

Value	Description	Default Port
`vite`	Fast development with Vite	5173
`nextjs`	Full-stack with Next.js	3000

npx @gavbarosee/react-kickstart my-app --framework nextjs

`--typescript`

Enable TypeScript support.

npx @gavbarosee/react-kickstart my-app --typescript

Includes:

TypeScript configuration (tsconfig.json)
Type definitions for all selected libraries
TypeScript-specific ESLint rules
Proper import/export types

Styling Options

`--styling <option>`

Choose your styling solution.

npx @gavbarosee/react-kickstart my-app --styling tailwind

Includes:

Tailwind CSS configuration
PostCSS setup
Utility-first CSS classes
Dark mode support
Responsive design utilities

Routing Options

Vite Projects

# Add React Router
npx @gavbarosee/react-kickstart my-app --framework vite --routing react-router
 
# No routing (single page)
npx @gavbarosee/react-kickstart my-app --framework vite --routing none

Next.js Projects

# App Router (recommended)
npx @gavbarosee/react-kickstart my-app --framework nextjs --next-routing app
 
# Pages Router (legacy)
npx @gavbarosee/react-kickstart my-app --framework nextjs --next-routing pages

State Management

`--state <option>`

Add state management to your project.

Option	Description	Best For
`redux`	Redux Toolkit with RTK Query	Complex apps, team projects
`zustand`	Lightweight state management	Simple to medium apps
`none`	No state management	Static sites, simple apps

npx @gavbarosee/react-kickstart my-app --state redux

Includes:

Redux Toolkit setup
RTK Query for API calls
Example store configuration
DevTools integration
TypeScript support

API Integration

`--api <option>`

Configure API integration and data fetching.

Option	Description	Includes
`axios-react-query`	Axios + React Query	HTTP client + caching
`fetch-react-query`	Fetch API + React Query	Native fetch + caching
`axios-only`	Axios only	HTTP client only
`fetch-only`	Fetch API only	Native fetch only
`none`	No API setup	Manual implementation

# Full-featured API setup
npx @gavbarosee/react-kickstart my-app --api axios-react-query
 
# Lightweight option
npx @gavbarosee/react-kickstart my-app --api fetch-only

Testing Options

`--testing <option>`

Add testing framework and configuration.

npx @gavbarosee/react-kickstart my-app --testing vitest

Perfect for Vite projects

Lightning-fast test execution
Native ES modules support
Built-in TypeScript support
Jest-compatible API

Deployment Options

`--deployment <option>`

Configure deployment settings and scripts.

npx @gavbarosee/react-kickstart my-app --deployment vercel

Includes:

vercel.json configuration
Optimized build settings
Environment variable setup
Automatic deployments on push

Development Options

`--package-manager <manager>`

Choose your package manager.

# Use npm (default)
npx @gavbarosee/react-kickstart my-app --package-manager npm
 
# Use yarn
npx @gavbarosee/react-kickstart my-app --package-manager yarn

If not specified, React Kickstart will auto-detect your preferred package manager based on lock files in the current directory.

`--no-git`

Skip Git repository initialization.

npx @gavbarosee/react-kickstart my-app --no-git

`--no-linting`

Skip ESLint and Prettier setup.

npx @gavbarosee/react-kickstart my-app --no-linting

`--skip-install`

Generate project files without installing dependencies.

npx @gavbarosee/react-kickstart my-app --skip-install

Useful for:

CI/CD environments
When you want to review generated files first
Custom dependency installation workflows

`--no-autostart`

Don't automatically start the development server.

npx @gavbarosee/react-kickstart my-app --no-autostart

Complete Examples

Full-Featured 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 Learning Project

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

Help and Version

`--help, -h`

Display help information.

npx @gavbarosee/react-kickstart --help

`--version, -v`

Display version information.

npx @gavbarosee/react-kickstart --version

Exit Codes

| Code | Meaning | ||| | 0 | Success | | 1 | General error | | 2 | Invalid arguments | | 3 | Directory already exists | | 4 | Network/installation error |

Pro Tip: Use --yes with specific flags for consistent, reproducible project generation in scripts and CI/CD pipelines.