Skip to content
xtarter
Blog

Getting Started with create-xtarter-app

create-xtarter-app scaffolds a new project from a curated template, installs its dependencies, and can initialize Git.

Quick start

Section titled “Quick start”
Terminal window
npm create xtarter-app@latest

The CLI prompts for a project name, template, package manager, Git init, and CI/CD cleanup. Use --yes / -y to accept the defaults (pnpm, next-chakra, Git init, no cleanup); the project name prompt still appears unless you pass a positional name. Explicit flags such as --pm bun or --clean take priority.

Scaffold with defaults
npm create xtarter-app@latest -- my-app --yes
Browse all templates

Step by step

Section titled “Step by step”

  1. 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

  2. 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

  3. 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

  4. 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.

  5. 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.

  6. 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.

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

When installation fails

Section titled “When installation fails”

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 gets modified after download

Section titled “What gets 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

Agent skills

Section titled “Agent skills”

Install the create-xtarter-app skill to teach a compatible AI tool how to scaffold projects, pick a template from a stack description, and use the right flags. It covers the scaffold and preview commands, all flags, and the five template IDs. Install it through the skills.sh ecosystem:

Terminal window
npx skills@latest add agustinusnathaniel/xtarter

Next steps

Section titled “Next steps”