shado-cli

README

Repository for the SHADO platform CLI tool.

What is this repository for?

This repository contains the CLI that allows to manage some aspects of the shado platform. The current version is able to manage the plugin creation, build and publish.

The CLI has been organized in a git-like style, like many other modern commadn line tools, with main commands and subcommands/actions.

At each command level a simple help menu will be provided to the user.

How do I get set up?

Configuration

After installing the required software dependencies you can install the shado-cli tool in your machine with the following shell command:

# install shado-cli globally on your machine
sudo npm install -g shado-cli

If the tool has been installed correctely you can check the version and see the main help menu with the following commands:

shado-cli --version
shado-cli --help

Dependencies

The project has been configured using npm, so all dependencies on packages are listed inside the package.json file. When you install the tool it will be available in your $PATH environment variable as a binary tool called shado-cli.

This tool requires the following software installed on your machine:

• NodeJS due to npm libraries used to create the tool and implement some functionalities;
• Docker Engine is required to build and push the backend image for SHADO plugins (when required);
• Docker Cloud this account is required if you want to publish the SHADO plugin backend in the default Docker registry.

How to use it

In the current version it is possible to execute commands/actions to manage the SHADO plugin development. You could see all the available actions typing the following command:

shado-cli --help 

Then you could invoke the following actions for SHADO plugin management:

• create a new plugin, generating the scaffold folder
• build a plugin, generating zip file and docker image
• distribute a plugin, pushing zip file and docker image

# run where you want to create the plugin folder
shado-cli plugin.create

# run inside the plugin folder
shado-cli plugin.build

# run inside the plugin folder
shado-cli plugin.publish

NOTE 1: All commands have been automatized as much as possible and will be improved over time!

NOTE 2: the zip created HAVE TO be uploaded manually to the SHADO platform by a admin user, through the GUI or the REST API!

Contribution guidelines

• Writing tests
• Code review
• Other guidelines

Who do I talk to?

• Repo owner or admin
• Other community or team contact