yeedu-cli 4.8.0rc1

Universal Command Line Interface for Yeedu.

This package offers a unified command line interface to Yeedu’s RESTful-API.

Getting Started

• Requirements

• Installation

• Configuration

• Environment Variables

• Credentials File

• Yeedu Session Token

• Basic Commands

Requirements

The yeedu-cli package works on Python version:

• 3.8.x and greater

Installation

Installation of the Yeedu CLI and its dependencies use a range of packaging features provided by pip and setuptools. To ensure smooth installation, it’s recommended to use:

• pip: 20.0.2 or greater

• setuptools: 59.6.0 or greater

python3 -m pip install yeedu-cli

Configuration

Before using the Yeedu CLI, you need to configure your credentials. You can do this in several ways:

• Environment Variables

• Credentials file

Note: Environment variables are given priority.

Environment Variables

# Below mentioned values are the default values of Environment Variables
YEEDU_RESTAPI_URL="http://localhost:8080"
YEEDU_CLI_LOG_DIR="/.yeedu/cli/logs/"
YEEDU_USERNAME=USER
YEEDU_PASSWORD=PASS
YEEDU_RESTAPI_TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFiY2RlZiIsImlkIjoiMSIsImlhdCI6MTY2NzgwOTYwMX0.HwhdTHBttnR0NFtmUDjcxTLMSLfyNuBs7t7GO9zOf08
YEEDU_RESTAPI_TOKEN_FILE_PATH="/home/user/yeedu_cli.config"
YEEDU_CLI_VERIFY_SSL=true

# Provide the YEEDU_SSL_CERT_FILE path if YEEDU_CLI_VERIFY_SSL is set to true.
YEEDU_SSL_CERT_FILE="/home/user/crt"

Credentials File

The yeedu_credentials.config file needs to be created inside the directory home/user/.yeedu/ and should contain JSON formatted as shown below:

{
  "YEEDU_USERNAME": "USER",
  "YEEDU_PASSWORD": "PASS"
}

Yeedu Session Token

If the user already has the Yeedu Session Token, they can save the token at any location and provide the file path in the environment variable YEEDU_RESTAPI_TOKEN_FILE_PATH.

For example:

YEEDU_RESTAPI_TOKEN_FILE_PATH="/home/user/{FileName}"

• The format for storing the token is shown below:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxLCJpYXQiOjE2ODg3MjA0MjIsImV4cCI6MTY4ODg5MzIyMn0.EfxuXKPBISQB4ep-sPQbo6R7tg2irlnAC_krqnuXJ5Q"
}

Basic Commands

Yeedu CLI command has the following structure:

yeedu <command> <subcommand> [options and parameters]

For example, to list clusters, the command would be:

yeedu cluster list

To view help documentation, use one of the following:

yeedu --help
yeedu <command> --help
yeedu <command> <subcommand> --help

You can read more information on the Yeedu CLI Commands.