capri-create v1.0.0-next.1

Create Capri

The easiest way to get started with Capri is by using @capri-js/create. This CLI tool enables you to quickly start building a new Capri site, with everything set up for you. You can create a new site using the default template, or by using one of the official examples. To get started, use the following command:

npm init capri
# or
yarn create capri
# or

To create a new project in a specific folder, you can pass a name as argument argument

npm init capri -- my-capri-site
# or
yarn create capri my-capri-site

Options

create-capri comes with the following options:

• -e, --example name|github-url - An example to bootstrap the project with. You can use an example name from the Capri repo or a GitHub URL. The URL can use any branch and/or subdirectory.
• --example-path <path-to-example> - In a rare case, your GitHub URL might contain a branch name with a slash (e.g. bug/fix-1) and the path to the example (e.g. foo/bar). In this case, you must specify the path to the example separately: --example-path foo/bar