2021-05-03 12:15:13 -05:00
|
|
|
# create-astro
|
2021-05-03 13:26:10 -05:00
|
|
|
|
2021-05-03 12:15:13 -05:00
|
|
|
## Scaffolding for Astro projects
|
|
|
|
|
|
|
|
|
|
**With NPM:**
|
2021-05-03 13:26:10 -05:00
|
|
|
|
2021-05-03 12:15:13 -05:00
|
|
|
```bash
|
|
|
|
|
npm init astro
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
**With Yarn:**
|
2021-05-03 13:26:10 -05:00
|
|
|
|
2021-05-03 12:15:13 -05:00
|
|
|
```bash
|
|
|
|
|
yarn create astro
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
`create-astro` automatically runs in _interactive_ mode, but you can also specify your project name and template with command line arguments.
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
# npm 6.x
|
|
|
|
|
npm init astro my-astro-project --template blank
|
|
|
|
|
|
|
|
|
|
# npm 7+, extra double-dash is needed:
|
|
|
|
|
npm init astro my-astro-project -- --template blank
|
|
|
|
|
|
|
|
|
|
# yarn
|
|
|
|
|
yarn create astro my-astro-project --template blank
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
To see all available options, use the `--help` flag.
|
|
|
|
|
|
|
|
|
|
### Templates
|
|
|
|
|
|
|
|
|
|
The following templates are included:
|
|
|
|
|
|
|
|
|
|
- `starter`
|
|
|
|
|
- `blank`
|
|
|
|
|
|
|
|
|
|
Feel free to [open a PR](https://github.com/snowpackjs/astro/pulls) to add additional templates.
|
