# Getting Started with create-xtarter-app

## 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

Scaffold a new project in one command:

```bash
# Using pnpm (recommended)
pnpm create xtarter-app

# Using npm
npm create xtarter-app@latest

# Using bun
bun create xtarter-app

# Using yarn
yarn create xtarter-app
```

The interactive CLI will guide you through:
1. **Project name** — what to call your new project
2. **Template** — pick from Next.js, Vite + React, and more
3. **Package manager** — pnpm (recommended), npm, bun, or yarn
4. **Git init** — whether to initialize a git repository
5. **CI/CD cleanup** — whether to remove pre-configured CI configs

:::note
Use `--yes` / `-y` to skip prompts with defaults (pnpm, git init, no CI cleanup). Any explicit flag like `--pm bun` or `--clean` takes priority over `--yes`.
:::

```bash
# Scaffold with defaults
pnpm create xtarter-app my-app --yes

# Scaffold into current directory
pnpm create xtarter-app . -t vite-tailwind

# Overwrite existing directory
pnpm create xtarter-app my-app -t vite-tailwind --force

# Pin to a specific template version
pnpm create xtarter-app my-app --ref v1.0.0
```

## 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 |

[Browse all templates →](/create-xtarter-app/guide/templates/)

## Next Steps

- [Usage Guide](/create-xtarter-app/getting-started/usage/) — Walk through each prompt and option
- [CLI Reference](/create-xtarter-app/guide/cli/) — All commands, arguments, and flags
- [Template Catalog](/create-xtarter-app/guide/templates/) — Detailed descriptions of every template
- [Keep in Sync](/xtarterize/) — After scaffolding, use xtarterize to maintain your configs