astro/packages/create-astro
Houston (Bot) 9b84a7ef96
[ci] release (#8590)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2023-09-19 17:21:05 +08:00
..
src [ci] format 2023-09-19 09:11:23 +00:00
test feat(create-astro): Update flag behavior for template and project-name (#8551) 2023-09-19 17:09:27 +08:00
CHANGELOG.md [ci] release (#8590) 2023-09-19 17:21:05 +08:00
create-astro.mjs Improve create-astro startup performance (#8456) 2023-09-13 09:40:53 -05:00
package.json [ci] release (#8590) 2023-09-19 17:21:05 +08:00
README.md chore(create-astro): Added create project using pnpm (#8340) 2023-09-13 16:58:18 +02:00
tsconfig.json config: migrate us to moduleResolution: 'node16' (#8519) 2023-09-13 16:49:22 +02:00

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
--template <name> Specify your template.
--install / --no-install Install dependencies (or not).
--git / --no-git Initialize git repo (or not).
--yes (-y) Skip all prompt by accepting defaults.
--no (-n) Skip all prompt by declining defaults.
--dry-run Walk through steps without executing.
--skip-houston Skip Houston animation.
--typescript <option> TypeScript option: strict / strictest / relaxed.