connect-cli 40.6

CloudBlue Connect Command Line Interface

CloudBlue Connect Command Line Interface

Introduction

The CloudBlue Connect Command Line Interface (CLI) is an extensible unified tool to perform various automation scenarios. With just one tool, you can control multiple Connect modules from the command line and automate them through scripts.

Since it is extensible, users can write their own plugins to extend its functionalities.

Install

Prerequisites

connect-cli depends on Git, Cairo, Pango and GDK-PixBuf.

Please refers to the platform-specific instructions on how to install these dependecies:

• Linux
• Mac OS
• Windows

Using PIP

To use connect-cli you need a system with python 3.8 or later installed.

    $ pip install --upgrade connect-cli

Using Docker

To use the Docker image of connect-cli:

    $ docker run -it -v $HOME/.ccli:/home/connect/.ccli cloudblueconnect/connect-cli ccli

Please refer to the connect-cli docker image documentation for more information.

Using Homebrew on Mac OS

To install connect-cli with homebrew run:

    $ brew update
    $ brew tap cloudblue/connect
    $ brew install cloudblue/connect/connect-cli

Using the installer on Windows

An installer package is available for Windows 10 or newer. You can download its zip file from the Github Releases page.

Usage

• General
• Locales
• Products
• Customers
• Reports
• Translations
• Projects
• Streams

Development

We use isort library to order and format our imports, and we check it using flake8-isort library (automatically on flake8 run).
For convenience you may run poetry run isort . to order imports.

Run tests

connect-cli uses poetry for dependencies management and packaging.

To run the connect-cli tests suite run:

$ pip install poetry
$ poetry install
$ poetry run pytest

License

connect-cli is released under the Apache License Version 2.0.