astro/packages/create-astro
Bryan Pan d45431d246
fix: add force to rm script in create-astro (#729)
* fix: add force to rm script in create-astro

* add changeset

* edit overwrite prompt

* rm cannot remove '.' or '..' -- creating a helper function to empty the directory

* delete symlinks

* comments
2021-07-19 18:55:35 -07:00
..
src fix: add force to rm script in create-astro (#729) 2021-07-19 18:55:35 -07:00
test [ci] yarn format 2021-07-07 20:10:09 +00:00
CHANGELOG.md Version Packages (#634) 2021-07-08 14:40:42 -04:00
create-astro.mjs add engines for esm support (#415) 2021-06-14 08:20:14 -04:00
package.json Version Packages (#634) 2021-07-08 14:40:42 -04:00
README.md Implements templates from external repos (#603) 2021-07-06 15:14:22 -04:00
tsconfig.json tsconfig fix (#752) 2021-07-19 18:23:39 -07:00
yarn.lock redesign create-astro (#301) 2021-06-08 11:10:56 -04:00

create-astro

Scaffolding for Astro projects

With NPM:

npm init astro

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 init astro my-astro-project --template starter

# npm 7+, extra double-dash is needed:
npm init astro my-astro-project -- --template starter

# yarn
yarn create astro my-astro-project --template starter

Check out the full list of example starter templates, available on GitHub.

You can also use any GitHub repo as a template:

npm init astro my-astro-project -- --template cassidoo/shopify-react-astro

CLI Flags

May be provided in place of prompts

Name Description
--template Specify the template name (list)
--commit Specify a specific Git commit or branch to use from this repo (by default, main branch of this repo will be used)