OSSPIM CLI

Bootstrap an app or instance running on the headless ecommerce and GraphQL based Product Information Management service OSSPIM.

Usage

You'll need the following installed to use OSSPIM CLI:

• Node.js (>=12)

To create a new app using OSSPIM, simply run the following command:

npx @osspim/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 @osspim/cli --help

Bootstrapping an instance

npx @osspim/cli --bootstrap-instance

or

npx @osspim/cli -b

This will bootstrap an existing instance with example data

Templates

The default mode of the OSSPIM 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.

cli