0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-16 21:46:22 -05:00
astro/packages/create-astro
Bjorn Lu 8e3cb20b5c
Format markdown files (#7439)
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
2023-06-26 11:34:13 +08:00
..
src fix: pnpm failure on create-astro (#7435) 2023-06-21 16:02:20 -04:00
test Fix changeset publish (#6923) 2023-04-27 22:55:48 +08:00
CHANGELOG.md [ci] release (#7434) 2023-06-22 10:06:15 -04:00
create-astro.mjs create-astro bug fixes (#5319) 2022-11-08 10:33:36 -06:00
package.json [ci] release (#7434) 2023-06-22 10:06:15 -04:00
README.md Format markdown files (#7439) 2023-06-26 11:34:13 +08:00
tsconfig.json Update compilation target for Node 16 (#6213) 2023-03-06 13:57:16 -05:00

create-astro

Scaffolding for Astro projects

With NPM:

npm create astro@latest

With Yarn:

yarn create astro

create-astro automatically runs in interactive mode, but you can also specify your project name and template with command line arguments.

# npm 6.x
npm create astro@latest my-astro-project --template minimal

# npm 7+, extra double-dash is needed:
npm create astro@latest my-astro-project -- --template minimal

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