mirror of
https://github.com/withastro/astro.git
synced 2024-12-16 21:46:22 -05:00
9f067dca27
* chore: remove changesets patch * chore: add changesets * chore: version packages * chore: normalize formatting * chore: update lockfile * chore: fix codeblocks * Update packages/astro/CHANGELOG.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update packages/astro/CHANGELOG.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * Update packages/astro/CHANGELOG.md Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * chore: fixup code samples * chore: move v0.25 message out of note Co-authored-by: Nate Moore <nate@astro.build> Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> |
||
---|---|---|
.. | ||
src | ||
test | ||
tsconfigs | ||
CHANGELOG.md | ||
create-astro.mjs | ||
package.json | ||
README.md | ||
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