Getting Started with create-xtarter-app
What is create-xtarter-app?
Section titled “What is create-xtarter-app?”create-xtarter-app scaffolds a new project from a curated set of production-grade
templates. Every template comes pre-configured with Biome linting & formatting,
TypeScript strict mode, GitHub Actions CI, and more - no setup required.
Quick Start
Section titled “Quick Start”Scaffold a new project in one command:
npm create xtarter-app@latestpnpm create xtarter-app@latestyarn create xtarter-appbun create xtarter-app@latestThe interactive CLI will guide you through:
- Project name - what to call your new project
- Template - pick from Next.js, Vite + React, and more
- Package manager - pnpm (recommended), npm, bun, or yarn
- Git init - whether to initialize a git repository
- CI/CD cleanup - whether to remove pre-configured CI configs
npm create xtarter-app@latest -- my-app --yespnpm create xtarter-app@latest my-app --yesyarn create xtarter-app my-app --yesbun create xtarter-app@latest my-app --yesnpm create xtarter-app@latest -- . -t vite-tailwindpnpm create xtarter-app@latest . -t vite-tailwindyarn create xtarter-app . -t vite-tailwindbun create xtarter-app@latest . -t vite-tailwindnpm create xtarter-app@latest -- my-app -t vite-tailwind --forcepnpm create xtarter-app@latest my-app -t vite-tailwind --forceyarn create xtarter-app my-app -t vite-tailwind --forcebun create xtarter-app@latest my-app -t vite-tailwind --forcenpm create xtarter-app@latest -- my-app --ref v1.0.0pnpm create xtarter-app@latest my-app --ref v1.0.0yarn create xtarter-app my-app --ref v1.0.0bun create xtarter-app@latest my-app --ref v1.0.0What you get
Section titled “What you get”Every template ships with a complete, production-ready setup:
| Tool | What’s configured |
|---|---|
| Biome | Linting rules, formatting config, VS Code integration |
| TypeScript | Strict mode, path aliases, compiler settings |
| GitHub Actions | CI workflows for lint, type-check, test |
| VS Code | Editor settings, recommended extensions |
| Agent Skills | AI agent configuration files |
Next Steps
Section titled “Next Steps”- Usage Guide - Walk through each prompt and option
- CLI Reference - All commands, arguments, and flags
- Template Catalog - Detailed descriptions of every template
- Keep in Sync - After scaffolding, use xtarterize to maintain your configs