@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 multi-market commerce API and order management system that lets you add global shopping capabilities to any website, mobile app, chatbot, wearable, voice, or IoT device, with ease. Compose your stack with the best-of-breed tools you already mastered and love. Make any experience shoppable, anywhere, through a blazing-fast, enterprise-grade, and secure API.

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/cli

yarn global add @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 autocomplete - Display autocomplete installation instructions.
• commercelayer cli - Core CLI commands.
• commercelayer help - Display help for commercelayer.
• commercelayer plugins - Manage CLI plugins.

Plugins

The Commerce Layer CLI currently supports the following plugins:

• resources - Execute CRUD operations on API resources.
• seeder - Execute Commerce Layer seeder.
• imports - Import resources in Commerce Layer.
• webhooks - Manage webhooks in Commerce Layer.
• orders - Execute actions on orders in Commerce Layer.
• checkout - Generate checkout URLs.
• triggers - Execute actions on resources in Commerce Layer.
• token - Manage Commerce Layer access tokens.
• microstore - Generate Microstore URLs.
• exports - Export resources from Commerce Layer.
• cleanups - Cleanup resources from Commerce Layer.
• tags - Manage resources tags in Commerce Layer.
• provisioning - Make requests to Commerce Layer's Provisioning API.

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. Join Commerce Layer's Slack community.

2. Create an issue in this repository.

3. Ping us on Twitter.

License

This repository is published under the MIT license.