summaryrefslogtreecommitdiff
path: root/packages/create-astro/README.md
blob: ff0c9993bee6cb26e132c13f44b64a60b7e392fa (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
# 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 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.