Crystallize CLI
Bootstrap an app or tenant running on the headless ecommerce and GraphQL
based Product Information Management service Crystallize.
Usage
You'll need the following installed to use Crystallize CLI:
To create a new app using Crystallize, simply run the following command:
npx @crystallize/cli <project-name>
This will walk you through creating a project, allowing you to choose which
template and preferences you want to use.
Show help
npx @crystallize/cli --help
Bootstrapping a tenant
npx @crystallize/cli --bootstrap-tenant
or
npx @crystallize/cli -b
This will bootstrap an existing tenant with example data
Templates
The default mode of the Crystallize CLI is to use a template. Each template has
different options that can be chosen to configure the initial project to suit
your needs.
Current templates include:
- Complete Ecommerce (Next.js + React)
- Content & Commerce (Next.js + React)
- Gatsby (React)
- Nuxt (Vue.js)
- Service API (Node.js)
- React Native (beta)
Contributing
If you'd like to help improve our CLI tool, check out the contributing
guidelines for an overview of the codebase and structure.