Installation

Installation#

Warning

Project Neo is currently in Technical Preview. Features described in this section may change before general availability.

The genai command line tool is how you author, validate, and deploy an agent configuration. It is distributed as the squirro-genai Python package, which installs the genai command. This page covers what you need and how to install it.

Requirements#

  • Python 3.11 or later.

  • Your Squirro instance URL and a refresh token, so the CLI can authenticate to your cluster. A refresh token is generated in the API Access section of the Squirro settings, as described on the Authentication page.

Squirro recommends installing the CLI into an isolated Python environment, such as a virtual environment, to keep it separate from other Python packages on your machine.

Availability#

During Technical Preview, the squirro-genai package is published only to the internal Squirro package index. It is not available from a public package index such as PyPI. If you are outside Squirro and want to try the genai CLI, visit the Squirro Support website and submit a technical support request for access to the Technical Preview.

Install#

During Technical Preview, install the package from an environment that is configured to reach the internal Squirro package index, such as a Squirro-managed workstation or build environment. From the default public package index, the command does not resolve.

pip install squirro-genai

To update an existing installation to a newer version:

pip install --upgrade squirro-genai

Verify#

Confirm that the CLI is installed and available on your path:

genai --help

The command lists the available verbs, such as init, lint, deploy, and explain. Every run also prints a short Technical Preview notice, a reminder that the commands and the configuration schema may change before general availability.

Once the CLI is installed, continue to the Quick Start page to author and deploy your first configuration.


Contents