History

Konstantinos Kostarellis b4dbb90b5f Adds a new example template portfolio-svelte (#1667 ) - Template is based on svelte components instead of react - Bumps astro version to "^0.21.0-next.0" for portfolio-svelte template Co-authored-by: Konstantinos Kostarellis <Konstantinos.Kostarellis@gmail.com>		2021-11-02 12:48:00 -04:00
..
src	Adds a new example template portfolio-svelte (#1667 )	2021-11-02 12:48:00 -04:00
test	[ci] yarn format	2021-07-07 20:10:09 +00:00
CHANGELOG.md	Version Packages (#1642 )	2021-10-22 17:03:09 -05:00
create-astro.mjs	[ci] yarn format	2021-09-06 08:25:23 +00:00
package.json	Version Packages (#1642 )	2021-10-22 17:03:09 -05:00
README.md	Implements templates from external repos (#603 )	2021-07-06 15:14:22 -04:00
tsconfig.json	tsconfig fix (#752 )	2021-07-19 18:23:39 -07:00
yarn.lock	redesign create-astro (#301 )	2021-06-08 11:10:56 -04: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)