blob: 5341d60f02e5d95cf67763a12cb79e7cf69c2779 (
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
|
# 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 minimal
# npm 7+, extra double-dash is needed:
npm create astro@latest my-astro-project -- --template minimal
# yarn
yarn create astro my-astro-project --template minimal
```
[Check out the full list][examples] of example 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 <name>` | Specify your template. |
| `--install` / `--no-install` | Install dependencies (or not). |
| `--git` / `--no-git` | Initialize git repo (or not). |
| `--yes` (`-y`) | Skip all prompt by accepting defaults. |
| `--no` (`-n`) | Skip all prompt by declining defaults. |
| `--dry-run` | Walk through steps without executing. |
| `--skip-houston` | Skip Houston animation. |
| `--typescript <option>` | TypeScript option: `strict` / `strictest` / `relaxed`. |
[examples]: https://github.com/withastro/astro/tree/main/examples
[typescript]: https://github.com/withastro/astro/tree/main/packages/astro/tsconfigs
|
