This package offers a unified command line interface to Yeedu’s RESTful-API.
Getting Started
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-cliConfiguration
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 listTo view help documentation, use one of the following:
yeedu --help
yeedu <command> --help
yeedu <command> <subcommand> --helpYou can read more information on the Yeedu CLI Commands.
1 maintainer
Metadata
1 maintainer
Release files for yeedu-cli 4.13.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| yeedu_cli-4.13.0.tar.gz | 96.3 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| yeedu_cli-4.13.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 252.0 kB
Release files / yeedu_cli-4.13.0.tar.gz
| Download URL | yeedu_cli-4.13.0.tar.gz |
|---|---|
| Size | 96.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b9b801af051c43f3b33dc92a581268ac645f8f9001d0833bb83318f88925042d
|
|
BLAKE2b-256 checksum How to use checksums |
12e64f27738500aaae933e980af0c006ca9a7148ca8f4fc8c4a363a221b5a5c4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 9, 2026.
Transparency logRelease files / yeedu_cli-4.13.0-py3-none-any.whl
| Download URL | yeedu_cli-4.13.0-py3-none-any.whl |
|---|---|
| Size | 155.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ec061b8a5cca0c59ab61701efd674376a76a26c7ec1383350912cd7bcc50a7be
|
|
BLAKE2b-256 checksum How to use checksums |
ebb1f450c410dad7b1e7cc77d8ec78d481d9c95e699d06a7084f997541e192e9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 9, 2026.
Transparency logSecurity for yeedu-cli 4.13.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for yeedu_cli-4.13.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 9, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
