mirror of
https://github.com/withastro/astro.git
synced 2024-12-16 21:46:22 -05:00
9263e96593
Co-authored-by: Reuben Tier <64310361+TheOtterlord@users.noreply.github.com> Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> Co-authored-by: Bjorn Lu <bjornlu.dev@gmail.com> Co-authored-by: Florian Lefebvre <contact@florian-lefebvre.dev> Co-authored-by: Reuben Tier <otterlord.dev@gmail.com>
1.9 KiB
1.9 KiB
create-astro
Scaffolding for Astro projects
With NPM:
npm create astro@latest
With Yarn:
yarn create astro
With PNPM:
pnpm create astro
create-astro automatically runs in interactive mode, but you can also specify your project name and template with command line arguments.
# npm
npm create astro@latest my-astro-project -- --template minimal
# yarn
yarn create astro my-astro-project --template minimal
# pnpm
pnpm create astro my-astro-project --template minimal
Check out the full list of example templates, available on GitHub.
You can also use any GitHub repo as a template:
npm create astro@latest my-astro-project -- --template cassidoo/shopify-react-astro
CLI Flags
May be provided in place of prompts
| Name | Description |
|---|---|
--help (-h) |
Display available flags. |
--template <name> |
Specify your template. |
--install / --no-install |
Install dependencies (or not). |
--add <integrations> |
Add integrations. |
--git / --no-git |
Initialize git repo (or not). |
--yes (-y) |
Skip all prompts by accepting defaults. |
--no (-n) |
Skip all prompts by declining defaults. |
--dry-run |
Walk through steps without executing. |
--skip-houston |
Skip Houston animation. |
--ref |
Specify an Astro branch (default: latest). |
--fancy |
Enable full Unicode support for Windows. |