@commercelayer/commercelayer-cli

Commerce Layer CLI

The official Commerce Layer CLI which helps you to manage your Commerce Layer applications right from the terminal.

What is Commerce Layer?

Commerce Layer is a headless commerce platform and order management system that lets you add global shopping capabilities to any website, mobile app, chatbot, or IoT device, with ease. Perfect fit for the best-of-breed CMSs, static site generators, and any other tools you already master and love, our blazing-fast and secure API will help you make your content shoppable on a global scale.

Table of contents

• Installation
• Usage
• Commands
• Plugins
• Contributors Guide
• Need help?
• License

Installation

Run the command below to install the CLI using your favorite package manager:

npm install -g @commercelayer/commercelayer-cli

yarn global add @commercelayer/commercelayer-cli

More installation options, coming soon...

Usage

Installing the CLI provides access to the commercelayer, clayer, and cl command.

$ (commercelayer | clayer | cl) COMMAND

$ commercelayer (-v | version | --version) to check the version of the CLI you have installed.

$ commercelayer help [COMMAND]
or
$ commercelayer [COMMAND] (--help | -h) for detailed information about CLI commands.

Kindly check out this quick step-by-step example which will show you how to place an order using this CLI.

Commands

The Commerce Layer CLI supports the following commands:

• commercelayer applications - Manage login to CLI applications.
• commercelayer help - Display help for commercelayer.
• commercelayer plugins - Manage CLI plugins.
• commercelayer util - Decode a Commerce Layer JWT.

Plugins

The Commerce Layer CLI currently supports the following plugins:

• resources - Execute CRUD operations on API resources.
• seeder - Execute Commerce Layer seeder.

You can run the command below to get a list of all available CLI plugins:

commercelayer plugins:available

You can run the command below to update all available CLI plugins:

commercelayer plugins:update

Contributors Guide

1. Fork this repository (learn how to do this here).

2. Clone the forked repository like so:

git clone https://github.com/<your username>/commercelayer-cli.git && cd commercelayer-cli

3. Make your changes and create a pull request (learn how to do this).

4. Someone will attend to your pull request and provide some feedback.

Need help?

1. Request an invite to join Commerce Layer's Slack community (kindly scroll down to the bottom of the page).

2. Create an issue in this repository.

3. Ping us on Twitter.

License

This repository is published under the MIT license.