The CLI (Command Line Interface) tool was developed specifically for the cioplenu platform for automation and integration into other system landscapes.
It allows you to perform or read out operations that are also performed in the GUI in a "machine-compatible" way.
The CLI tool can be used independently or in conjunction with a script language such as Python to automate processes and recurring tasks or to implement company-specific logic.
Please contact us at [email protected] to provide the CLI tool.
Setting up the CLI tool
In order to use the CLI tool, only a few manual steps are required for setup.
After you have downloaded and unpacked the package it is sufficient to copy the executable file (depending on the operating system) into a directory of your choice.
For the sake of simplicity we recommend to abbreviate the folder name in cio.
This makes it easier to work with the tool later. All commands always start with the file name
cio followed by other parameters.
After the first login a file
.cio.yml is created.
This file contains the login information and can be modified at any time.
Also included in the zip directory is a detailed documentation with all commands and options.
Create a user for the CLI tool and create a token
To be able to log on to the server with the CLI tool in the next step, you must create a user and generate a so-called token (access key) for this user.
The App User checkbox must be set in the settings for the user.
As soon as the user has been activated as App user, a key-icon to the user appears in the overview table. Klick on the key-icon.
With this key you can access a window by creating a token.
To create the token, click on the update icon.
Since you can use this token to access the system without entering a username or password, we recommend that you always limit a token to a certain time. To do this, select an appropriate expiration date.
Attention: After the expiration date, you have to create the token again
Connect to the server
To connect to the server initially, enter
cio login in the console.
URL shows up. Copy the URL of the server and confirm with the enter key.
After that the next line
Token appears. Now paste the copied token here.
Finally, the server gives feedback on connection and correct authentication as well as the current version of the software. Make sure that the corresponding ports are enabled. For the default secure HTTPS connection, port 443 is used (HTTP - port 80).
This registration only needs to be made once and remains valid until the token has expired.
This means that the next time the command line is called,
cio login does not have to be entered again.
Commands are sent using the
cio help gives you an overview of all available commands.
cio ping tests the connection and correct authentication to the server.