connect-cli 22.25

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, user can write your own plugins to extend its functionalities.

Install

Prerequisites

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

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

• Linux
• Mac OSX
• Windows

Using PIP

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

    $ pip install --upgrade connect-cli

Binary distributions

A single executable binary distribution is available for windows, linux and mac os x. You can it from the Github Releases page.

To install under linux:

    $ curl -O -J https://github.com/cloudblue/connect-cli/releases/download/xx.yy/connect-cli_xx.yy_linux_amd64.tar.gz
    $ tar xvfz connect-cli_xx.yy_linux_amd64.tar.gz
    $ sudo cp dist/ccli /usr/local/bin/ccli

To install under Mac OS X:

    $ curl -O -J https://github.com/cloudblue/connect-cli/releases/download/xx.yy/connect-cli_xx.yy_osx_amd64.tar.gz
    $ tar xvfz connect-cli_xx.yy_osx_amd64.tar.gz
    $ sudo cp dist/ccli /usr/local/bin/ccli

If your user is not a sudoer, you can copy the ccli executable from the dist directory to a directory of your choice that is listed in the PATH variable.

To install under Windows

Download the windows single executable zipfile from Github Releases, extract it and place it in a folder that is included in your PATH system variable.

Usage

• General
• Products
• Customers
• Reports

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.