Prerequisites

• A Squirro instance with Squirro Neo

  To activate Neo on your instance, see the Setup page.

• A target Squirro project

  An existing Squirro project, create one first if it does not exist yet.

• The genai command line tool

  Install the genai CLI, which requires Python 3.11 or later. See the Installation page.

• A refresh token for a project Administrator

  Deploying requires the Administrator role on the target project, so authenticate with a refresh token that belongs to a project Administrator. For the role requirement, see the Authentication and Authorization section on the API Reference page and the Squirro Roles & Permissions page. For how to generate a refresh token, see the Authentication page.

• Device login turned on (recommended)

  With device login, the CLI authenticates through a browser signed in to the cluster, with no refresh token to copy. A server administrator turns it on, as described in the Turning On Device Login section.

• Registered credential handles

  Each model, and any authenticated knowledge graph or MCP server, references its credential by a handle whose value is bound on the cluster. Register the handles your configuration references before you deploy, or the deploy is rejected. See the Registering a Handle section.

Next Steps

With these in place, follow the Quick Start page to author, validate, and deploy your first configuration. For the concepts behind what you author, see the Overview page.