b8c6dabfb7
* enabling eslint on the all packages and tests * enabling for all packages * TEMP: adding an only() test to verify it fails CI * using our eslint config and ignore in CI * removing the temporary .only() test * update lock file * lint: fixing new test with a no-shadow warning * chore: update lock file |
||
|---|---|---|
| .. | ||
| src | ||
| test | ||
| 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