FRAME CLI

Command line interface for managing FRAME hybrid models

🐇 Quick start

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 show which command must be run to download and setup specific units.

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

frame --install-completion

💾 Installation for development

To install FRAME CLI for development in your current Python environment, you can use the following command. Feel free to use a virtual environment if you want to keep your system clean.

git clone https://github.com/CHANGE-EPFL/frame-project-cli.git
cd frame-cli
make install

Create a .env file in the root of your project with the following content (or export environment variables in your shell):

FRAME_CLI_LOGGING_LEVEL=INFO

✅ Running tests

make test