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
Metadata
1 maintainer
Release files for yellowdog-cli 10.8.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| yellowdog_cli-10.8.8.tar.gz | 499.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| yellowdog_cli-10.8.8-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 805.1 kB
Release files / yellowdog_cli-10.8.8.tar.gz
| Download URL | yellowdog_cli-10.8.8.tar.gz |
|---|---|
| Size | 499.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
69f3e7db15f1e03930483feda982282ceb8ba1c8fc15be9ed35d8f0b6965bd36
|
|
BLAKE2b-256 checksum How to use checksums |
480895451f39fdeba676648afc285028f5815dca44d9189ebc3234f6be7427a8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / yellowdog_cli-10.8.8-py3-none-any.whl
| Download URL | yellowdog_cli-10.8.8-py3-none-any.whl |
|---|---|
| Size | 305.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
41b682ed04384d6d4a5aedf57a649857571950ae9b8b201e594843e997df67ac
|
|
BLAKE2b-256 checksum How to use checksums |
eaa3b1b61dd2a1bfdcffdbd7be014c484178b0b4f5de7406e9e7c3ab152d117a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
