# iai

### iai

InteractiveAI's CLI

#### Synopsis

InteractiveAI's CLI to interact with its platform.

Use the subcommands below to manage your organizations, projects, agents, services, secrets, prompts, routines, policies, variables, glossaries, macros, and other components.

### Install

The CLI is distributed through Go's package manager, so it must first be installed. Click on [this](https://go.dev/doc/install) link and follow the instructions to do so.

To validate the installation run:

```bash
go version
```

Once Go is installed, ensure Go binaries are in your PATH:

```bash
export PATH=$PATH:$(go env GOPATH)/bin
```

Add this line to your shell profile (\~/.bashrc, \~/.zshrc, etc.) to make it permanent.

Now install InteractiveAI's CLI with the following command:

```bash
go install github.com/Interactive-AI-Labs/interactive-cli/cmd/iai@latest
```

Verify the installation by running:

```bash
iai --help
```

***

#### Options

```
      --api-key string               API key for authentication
      --cfg-file string              Path to YAML config file with organization, project, and optional service definitions
      --deployment-hostname string   Hostname for the deployment API (default "https://deployment.interactive.ai")
  -h, --help                         help for iai
      --hostname string              Hostname for the API (default "https://app.interactive.ai")
```

#### SEE ALSO

* [iai agents](/cli/iai_agents.md) - Deploy AI agents with policies, routines, and tools
* [iai comments](/cli/iai_comments.md) - Annotate traces, observations, and sessions
* [iai completion](/cli/iai_completion.md) - Generate the autocompletion script for the specified shell
* [iai databases](/cli/iai_databases.md) - PostgreSQL instances with extension support, including pgvector
* [iai dataset-items](/cli/iai_dataset-items.md) - Manage items in evaluation datasets
* [iai dataset-runs](/cli/iai_dataset-runs.md) - Run evaluations against datasets
* [iai datasets](/cli/iai_datasets.md) - Create and list evaluation datasets
* [iai glossaries](/cli/iai_glossaries.md) - Domain vocabularies for consistent term interpretation
* [iai images](/cli/iai_images.md) - Build and push container images
* [iai login](/cli/iai_login.md) - Authenticate with InteractiveAI
* [iai logout](/cli/iai_logout.md) - Clear local session
* [iai macros](/cli/iai_macros.md) - Pre-approved response templates used in routines
* [iai metrics](/cli/iai_metrics.md) - Query aggregated observability metrics
* [iai observations](/cli/iai_observations.md) - Inspect spans within traces
* [iai organizations](/cli/iai_organizations.md) - Switch or list organizations
* [iai policies](/cli/iai_policies.md) - Single-step behavioral rules for agents
* [iai projects](/cli/iai_projects.md) - Switch or list projects
* [iai prompts](/cli/iai_prompts.md) - Versioned prompts for agents, evaluators, and guardrails
* [iai queue-items](/cli/iai_queue-items.md) - Manage items in annotation queues
* [iai queues](/cli/iai_queues.md) - Annotation queues for human review workflows
* [iai replicas](/cli/iai_replicas.md) - Inspect service replicas
* [iai routines](/cli/iai_routines.md) - Multi-step behavioral processes for agents
* [iai run-items](/cli/iai_run-items.md) - Inspect results of evaluation runs
* [iai score-configs](/cli/iai_score-configs.md) - Define scoring schemas for evaluation
* [iai scores](/cli/iai_scores.md) - Read and write evaluation scores
* [iai secrets](/cli/iai_secrets.md) - Encrypted key-value pairs for services and agents
* [iai services](/cli/iai_services.md) - Deploy and manage HTTP services
* [iai sessions](/cli/iai_sessions.md) - Browse trace-derived conversation sessions
* [iai skills](/cli/iai_skills.md) - Manage Interactive Copilot skills (not to be confused with context items that configure the Interactive Agent)
* [iai stacks](/cli/iai_stacks.md) - Declarative resource sync from config files
* [iai traces](/cli/iai_traces.md) - Browse agent decision traces with full attribution
* [iai update](/cli/iai_update.md) - Update iai to the latest version
* [iai variables](/cli/iai_variables.md) - Contextual attributes referenced in policies and routines


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.interactive.ai/cli/iai.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.