https://github.com/CrystallizeAPI/crystallize-cli
Scaffold a Crystallize project via the command line
https://github.com/CrystallizeAPI/crystallize-cli
Last synced: 9 months ago
JSON representation
Scaffold a Crystallize project via the command line
- Host: GitHub
- URL: https://github.com/CrystallizeAPI/crystallize-cli
- Owner: CrystallizeAPI
- License: mit
- Created: 2019-08-26T09:07:46.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T12:48:41.000Z (almost 3 years ago)
- Last Synced: 2025-02-28T23:57:52.775Z (10 months ago)
- Language: JavaScript
- Size: 3.65 MB
- Stars: 17
- Watchers: 6
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Crystallize CLI
[](https://travis-ci.org/CrystallizeAPI/crystallize-cli)
Bootstrap an app or tenant running on the [headless ecommerce][1] and GraphQL
based [Product Information Management][2] service [Crystallize][3].
## Usage
You'll need the following installed to use Crystallize CLI:
- [Node.js][7] (>=12)
To create a new app using Crystallize, simply run the following command:
```sh
npx @crystallize/cli
```
This will walk you through creating a project, allowing you to choose which
template and preferences you want to use.
### Show help
```sh
npx @crystallize/cli --help
```
### Bootstrapping a tenant
```sh
npx @crystallize/cli --bootstrap-tenant
```
or
```sh
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][9] for an overview of the codebase and structure.
[1]: https://crystallize.com/product
[2]: https://crystallize.com/product/product-information-management
[3]: https://crystallize.com/
[4]: https://github.com/CrystallizeAPI/crystallize-nextjs-boilerplate
[5]: https://github.com/CrystallizeAPI/crystallize-react-native-boilerplate
[6]: https://github.com/CrystallizeAPI/crystallize-flutter-boilerplate
[7]: https://nodejs.org
[9]:
https://github.com/CrystallizeAPI/crystallize-cli/blob/master/CONTRIBUTING.md