astro/packages/create-astro
2021-06-22 10:06:07 -04:00
..
src update small cli fixes (#512) 2021-06-22 10:06:07 -04:00
test Improve templates test (#377) 2021-06-11 15:07:30 -06:00
CHANGELOG.md Version Packages (#466) 2021-06-16 14:12:05 -04:00
create-astro.mjs add engines for esm support (#415) 2021-06-14 08:20:14 -04:00
package.json Version Packages (#466) 2021-06-16 14:12:05 -04:00
README.md Add integration test for templates (#372) 2021-06-10 10:30:48 -06:00
tsconfig.json redesign create-astro (#301) 2021-06-08 11:10:56 -04: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.

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)