mirror of
https://github.com/withastro/astro.git
synced 2024-12-23 21:53:55 -05:00
0408376281
* feat(create-astro): add houston, improve prompts * refactor(create-astro): move to giget * chore: add changeset * chore: update lockfile * test(create-astro): update tests to match new output * chore: prefer named functions * fix: update template prompt * fix: update typescript message * chore: add explicit --skip-houston flag * test(create-astro): skip flaky typescript test Co-authored-by: Nate Moore <nate@astro.build> |
||
|---|---|---|
| .. | ||
| src | ||
| test | ||
| CHANGELOG.md | ||
| create-astro.mjs | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
create-astro
Scaffolding for Astro projects
With NPM:
npm create astro@latest
With Yarn:
yarn create astro
create-astro automatically runs in interactive mode, but you can also specify your project name and template with command line arguments.
# 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 of example starter templates, available on GitHub.
You can also use any GitHub repo as a template:
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) |
--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.
# 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