Skip to content
xtarter
Blog

Usage Guide

Scaffolding a project

Section titled “Scaffolding a project”

  1. Start the wizard

    Section titled “Start the wizard”
    Terminal window
    npm create xtarter-app@latest

  2. Enter a project name

    Section titled “Enter a project name”

    Names allow letters, numbers, hyphens, and underscores, up to 214 characters. You can pass the name as a positional argument instead:

    Terminal window
    npm create xtarter-app@latest -- my-app

  3. Pick a template

    Section titled “Pick a template”

    The picker lists the five templates: next-chakra, next-tailwind, vite-chakra, vite-tailwind, and vite-hero. See Templates for details, or skip the prompt with --template / -t:

    Terminal window
    npm create xtarter-app@latest -- my-app --template vite-tailwind

  4. Choose a package manager

    Section titled “Choose a package manager”

    Choose pnpm (recommended), npm, bun, or yarn, or skip the prompt with --pm / -p:

    Terminal window
    npm create xtarter-app@latest -- my-app --pm bun

  5. Decide on git init

    Section titled “Decide on git init”

    Git init is on by default and creates a repository with an initial commit. It requires git on your system and is skipped automatically when git is not installed; use --no-git to skip it explicitly.

  6. Clean CI/CD configs (optional)

    Section titled “Clean CI/CD configs (optional)”

    When enabled, it removes pre-configured CI/CD files such as GitHub Actions workflows, .gitlab-ci.yml, .travis.yml, CircleCI, Vercel, Netlify, Railway, and Fly configs. Use --clean to enable it directly.

  7. Wait for download and install

    Section titled “Wait for download and install”

    The CLI downloads the template, updates the package.json name, installs dependencies, and initializes Git when enabled.

  8. You’re ready

    Section titled “You’re ready”

    The CLI prints the next commands (cd <project> and <package-manager> dev) and the chosen template name.

Preview a template

Section titled “Preview a template”
Preview a template
npm create xtarter-app@latest -- preview vite-tailwind

preview shows a template’s name, description, repository, branch, and features without scaffolding.

Installation failure

Section titled “Installation failure”

The CLI runs <package-manager> install after download. If installation fails, the process exits with an error and removes the target directory when the CLI created it. Files downloaded into an existing empty directory are kept, so you can run the install manually.

What’s modified after download

Section titled “What’s modified after download”
  • package.json name - lowercased, with unsupported characters replaced by hyphens
  • Workspace references - workspace: entries in pnpm.overrides are removed
  • CI/CD files - removed when --clean is enabled