​
TrueFoundry CLI Library

TrueFoundry CLI library to help you interact with the platform programmatically by
  • Interacting with the deployments side of TrueFoundry, enabling you to manage workspaces, deployments, applications, and view logs.
  • Providing experiment tracking capabilities, allowing you to track ML experiments and interact with ML repositories within TrueFoundry.

​
Install Truefoundry CLI

pip install -U "truefoundry"
You need Python >= 3.9 to use the Truefoundry CLI.By default just installing truefoundry does not include support to work with Workflows. To include support for Workflows install the workflow extra.
pip install -U "truefoundry[workflow]"

​
Authenticate CLI

To be able to use the TrueFoundry CLI, you first need to authenticate. You can login either via browser or using API Key.
To log in to TrueFoundry, run the following command:
tfy login --host <your-truefoundry-host> # e.g. host: https://myorg.truefoundry.cloud
The value for --host is the first part of the url when you open the platform. This domain might be subdomain of your organization. The below example shows https://myorg.truefoundry.cloud
This will prompt you to open a URL and show you a Submit button.Once you click on Submit, you will be signed in to the CLI.