0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-23 21:53:55 -05:00
astro/packages/create-astro
Nate Moore cf8015eaa2
fix: locale handling for logger (#3391)
* fix(#3309): use system default locale

* fix(#3309): use system default locale in create-astro

* test: add locale regression tests

* test: add i18n regression test
2022-05-18 10:45:09 -05:00
..
src fix: locale handling for logger (#3391) 2022-05-18 10:45:09 -05:00
test Feat: [create astro] git step (#3227) 2022-04-29 11:45:43 -04:00
CHANGELOG.md [ci] release (#3334) 2022-05-12 14:48:58 -06:00
create-astro.mjs Use accessible indentation (#2253) 2021-12-22 16:11:05 -05:00
package.json [ci] release (#3334) 2022-05-12 14:48:58 -06:00
README.md Add a verbose flag to create-astro (#2429) 2022-01-20 19:00:22 -05:00
tsconfig.json

create-astro

Scaffolding for Astro projects

With NPM:

npm init astro

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 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 of example starter templates, available on GitHub.

You can also use any GitHub repo as a template:

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)
--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 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