Skip to content
Velocity

create-velocity-astro

Scaffold production-ready Velocity projects in seconds with the official CLI tool.

Quick Start

Section titled “Quick Start”
Terminal window
pnpm create velocity-astro my-site

Interactive Wizard

Section titled “Interactive Wizard”

The CLI guides you through setup with an interactive wizard. Just run the command and answer the prompts:

┌  create-velocity-astro
│
◇  Where should we create your project?
│  my-awesome-site
│
◇  Include demo landing page and sample content?
│  Yes
│
◇  Which components would you like to include?
│  ● All components (recommended)
│  ○ UI components only
│  ○ UI + Patterns
│  ○ None (minimal)
│
◇  Add internationalization (i18n) support?
│  No
│
◇  Generate additional starter pages?
│  No
│
◆  Creating your project...

Wizard Steps

Section titled “Wizard Steps”

  1. Project Location

    Choose where to create your project. Enter a folder name or path.

  2. Demo Content

    Include the demo landing page, sample blog posts, and example pages? Great for learning and customizing.

  3. Component Selection

    Choose which UI components to include:

    • All components — Full 27+ component library
    • UI only — Core interface components
    • UI + Patterns — Add form patterns
    • None — Minimal, just layouts and SEO

  4. Internationalization

    Add multi-language support with locale routing, translations, and language switcher.

  5. Starter Pages

    Optionally generate additional pages like Services, Pricing, Team, etc.

What You Get

Section titled “What You Get”

Every Velocity project includes:

Astro 6

Latest Astro with View Transitions and Content Layer API.

Tailwind CSS v4

Modern utility-first CSS with native cascade layers.

TypeScript

Full type safety throughout your project.

27+ Components

Production-ready UI components with variants.

SEO Ready

Meta tags, Open Graph, JSON-LD schemas, sitemap.

Dark Mode

System-aware theme switching built in.

Skip the Wizard (Flags)

Section titled “Skip the Wizard (Flags)”

For automation or quick setups, use flags to skip prompts:

FlagTypeDefaultDescription
--demobooleanpromptInclude demo landing page and sample content
--componentsstringpromptComponent selection (see below)
--i18nbooleanpromptAdd internationalization support
--pagesbooleanfalseGenerate starter pages interactively
-y, --yesbooleanfalseSkip all prompts, use defaults
-h, --help--Show help message
-v, --version--Show version number

Quick Examples

Section titled “Quick Examples”
Terminal window
# Accept all defaults (full-featured)
pnpm create velocity-astro my-site -y


# Minimal project, no demo
pnpm create velocity-astro my-site -y --demo=false --components=none


# Full project with i18n
pnpm create velocity-astro my-site --demo --components --i18n

After Scaffolding

Section titled “After Scaffolding”

Once complete, the CLI shows next steps:

◆  Done! Your project is ready.


   Next steps:
   1. cd my-site
   2. npm run dev


   Your site will be at http://localhost:4321

Next Steps

Section titled “Next Steps”