mirror of
https://github.com/withastro/astro.git
synced 2024-12-23 21:53:55 -05:00
65 lines
1.9 KiB
Markdown
65 lines
1.9 KiB
Markdown
# create-astro
|
|
|
|
## Scaffolding for Astro projects
|
|
|
|
**With NPM:**
|
|
|
|
```bash
|
|
npm create astro@latest
|
|
```
|
|
|
|
**With Yarn:**
|
|
|
|
```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 create astro@latest my-astro-project --template starter
|
|
|
|
# npm 7+, extra double-dash is needed:
|
|
npm create astro@latest my-astro-project -- --template starter
|
|
|
|
# yarn
|
|
yarn create astro my-astro-project --template starter
|
|
```
|
|
[Check out the full list][examples] of example starter templates, available on GitHub.
|
|
|
|
You can also use any GitHub repo as a template:
|
|
|
|
```bash
|
|
npm create astro@latest 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][examples]) |
|
|
| `--commit` | Specify a specific Git commit or branch to use from this repo (by default, `main` branch of this repo will be used) |
|
|
| `--fancy` | For Windows users, `--fancy` will enable full unicode support |
|
|
| `--typescript` | Specify the [tsconfig][typescript] to use |
|
|
| `--yes`/`-y` | Skip prompts and use default values |
|
|
|
|
### Debugging
|
|
|
|
To debug `create-astro`, you can use the `--verbose` flag which will log the output of degit and some more information about the command, this can be useful when you encounter an error and want to report it.
|
|
|
|
```bash
|
|
# npm 6.x
|
|
npm create astro@latest my-astro-project --verbose
|
|
|
|
# npm 7+, extra double-dash is needed:
|
|
npm create astro@latest my-astro-project -- --verbose
|
|
|
|
# yarn
|
|
yarn create astro my-astro-project --verbose
|
|
```
|
|
|
|
[examples]: https://github.com/withastro/astro/tree/main/examples
|
|
[typescript]: https://github.com/withastro/astro/tree/main/packages/astro/tsconfigs
|