blob: 80a0da093ed9e78c2df57a36d5f422c814dfdbcc (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
# create-astro
## Scaffolding for Astro projects
**With NPM:**
```bash
npm init astro
```
**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 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][examples] of example starter templates, available on GitHub.
You can also use any GitHub repo as a template:
```bash
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][examples]) |
| `--commit` | Specify a specific Git commit or branch to use from this repo (by default, `main` branch of this repo will be used) |
### 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 init astro my-astro-project --verbose
# npm 7+, extra double-dash is needed:
npm init astro my-astro-project -- --verbose
# yarn
yarn create astro my-astro-project --verbose
```
[examples]: https://github.com/withastro/astro/tree/main/examples
|
