Command Line Interface for the YellowDog Platform
Overview
This is a set of Python CLI commands for interacting with the YellowDog Platform, also providing examples of usage of the YellowDog Python SDK.
The commands support:
- Aborting running Tasks with the
yd-abortcommand - Boosting Allowances with the
yd-boostcommand - Cancelling Work Requirements with the
yd-cancelcommand - Comparing whether Worker Pools are a match for Task Groups with the
yd-comparecommand - Creating, Updating and Removing Compute Source Templates, Compute Requirement Templates, Keyrings, Credentials, Image Families, Allowances, Configured Worker Pools, User Attributes, Namespace Policies, Groups, and Applications with the
yd-createandyd-removecommands - Copying files between remote data stores with the
yd-copycommand - Deleting files from a remote data store with the
yd-deletecommand - Downloading files from a remote data store with the
yd-downloadcommand - Finishing Work Requirements with the
yd-finishcommand - Following Event Streams for Work Requirements, Worker Pools and Compute Requirements with the
yd-followcommand - Waiting for Work Requirements, Worker Pools or Compute Requirements to reach a terminal state with the
yd-waitcommand - Instantiating Compute Requirements with the
yd-instantiatecommand - Listing YellowDog items using the
yd-listcommand - Listing remote data store contents with the
yd-lscommand - Provisioning Worker Pools with the
yd-provisioncommand - Resizing Worker Pools and Compute Requirements with the
yd-resizecommand - Showing the details of any YellowDog entity using its YellowDog ID with the
yd-showcommand - Showing the details of the current Application with the
yd-applicationcommand - Shutting Down Worker Pools and Nodes with the
yd-shutdowncommand - Submitting Node Actions to Worker Pool nodes with the
yd-nodeactioncommand - Starting HELD Work Requirements and Holding (or pausing) RUNNING Work Requirements with the
yd-startandyd-holdcommands - Submitting Work Requirements with the
yd-submitcommand - Terminating Compute Requirements with the
yd-terminatecommand - Uploading files to a remote data store with the
yd-uploadcommand - Cloud provider setup (AWS, Azure, GCP) with the
yd-cloudwizardcommand
Utility commands are also provided: yd-format-json, yd-help, yd-jsonnet2json, and yd-version. For a full list of commands run yd-help.
Installation
Python 3.10 or later is required.
pipx (recommended) — installs into an isolated environment and puts the commands on your PATH automatically:
pipx install yellowdog-cli
uv:
uv tool install yellowdog-cli
pip + virtual environment:
pip install yellowdog-cli
To add optional Jsonnet support:
pipx inject yellowdog-cli jsonnet # pipx
uv tool install "yellowdog-cli[jsonnet]" # uv
pip install "yellowdog-cli[jsonnet]" # pip
Commander GUI
An optional desktop GUI is available. Install it with the commander extra and launch it with yd-commander:
pip install -U "yellowdog-cli[commander]"
yd-commander
Documentation
Please see the documentation in the GitHub repository for full details.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file yellowdog_cli-10.8.2.tar.gz.
File metadata
- Download URL: yellowdog_cli-10.8.2.tar.gz
- Upload date:
- Size: 458.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c05ef1d2d49b3fa09502c7e086a7b7d19c856ee2bdd5a60778acb06f923197f2
|
|
| MD5 |
6a3adda730dc3eaa06e45bb3ad5cd7a3
|
|
| BLAKE2b-256 |
764450d50c53a367d9f227ceb150d6b5246cdeb20a59adcb64c6a8fc038ed244
|
File details
Details for the file yellowdog_cli-10.8.2-py3-none-any.whl.
File metadata
- Download URL: yellowdog_cli-10.8.2-py3-none-any.whl
- Upload date:
- Size: 289.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
36a19148e7d1825fc3f89309fe16695e3cd6bfdd4e6ab61b11c19ca0a6d326ee
|
|
| MD5 |
9956a38b493daa5774f2f218744bab9a
|
|
| BLAKE2b-256 |
f4261701f47571114aa063da8a08faf10e1259cd1f7d6967fecd5cb12bca59e1
|
