Command Line Interface

AI GO! command line interface (CLI) is distributed as a lightweight Python package. It is recommended to be installed locally in a virtual environment.

ComponentRequirement
Python Version3.10, 3.11, 3.12, 3.13
Operating SystemLinux, Windows, macOS

Install CLI

📘

Compatibility

To ensure compatibility between the CLI and the AI GO! application, it is required for both to have the same version.

uv pip install latticeflow-go-sdk
pip install latticeflow-go-sdk
What is my AI GO! Application Version?

Find the application version in the UI by following:

  1. Hover over your user icon in the top right corner,
  2. Copy the version by clicking on the 'App version' field.

Configure & Test CLI

Step 1: Get API Key

The API key is used as the only authentication method when using the SDK. Each user has an API key associated.

  1. Navigate to Settings.
  2. Open API Keys in the menu.
  3. Copy the API key.

Step 2: Configure CLI

Use the lf configure command below and follow these steps:

  1. AI GO! URL: Set the variable to your AI GO! deployment URL by replacing <aigo_url>.
  2. API Key: Set the variable to the API key from the previous step by replacing <api_key>.
lf configure --url <aigo_url> --api-key <api_key>