History

Francois Valdy 5f5dc60976 Add missing licenses to published packages (#2166 ) * chore: add missing licenses * chore: update package.json info Co-authored-by: Nate Moore <nate@skypack.dev>		2021-12-13 15:14:34 -06:00
..
src	Parse --renderers flag correctly when passed to the create-astro cli (#2124 )	2021-12-06 09:19:22 -05:00
test	Upgrade dependencies (#2085 )	2021-12-13 15:59:08 -05:00
CHANGELOG.md	chore: release (#2149 )	2021-12-09 04:57:08 -08:00
create-astro.mjs	[ci] yarn format	2021-09-06 08:25:23 +00:00
package.json	Add missing licenses to published packages (#2166 )	2021-12-13 15:14:34 -06:00
README.md	update repo URL (#1994 )	2021-11-23 14:47:05 -08:00
tsconfig.json	tsconfig fix (#752 )	2021-07-19 18:23:39 -07:00

README.md

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)