Quick start with the Frame CLI tool

To download models and components, and to setup environments to run those, your can use the dedicated CLI (command-line interface) tool.

Requirements

• uv Python package and project manager

• git version control system

💾 Installation

Frame CLI relies on uv to manage Python virtual environments. You need to install it first if you don’t already have it. Refer to the official uv documentation.

Then, run the following command to install Frame CLI:

uv tool install frame-cli

⌨️ Usage

To see the list of available commands, run:

frame --help

Hybrid model and component pages on the Frame library show which command must be run to download and setup specific units. Refer to the full User guide for more details on how to use the CLI tool.

You may want to install autocompletion for easier usage. To do so, run:

frame --install-completion

☹️ Uninstallation

To remove the CLI tool from your system, run the following command:

uv tool uninstall frame-cli