# iai

### iai

InteractiveAI's CLI

#### Synopsis

InteractiveAI's CLI to interact with its platform.

Use the subcommands below to manage your organizations, projects, services, secrets, prompts, routines, policies, variables, glossary, 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](https://docs.interactive.ai/cli/iai_agents) - Manage agents
* [iai comments](https://docs.interactive.ai/cli/iai_comments) - Manage comments
* [iai completion](https://docs.interactive.ai/cli/iai_completion) - Generate the autocompletion script for the specified shell
* [iai dataset-items](https://docs.interactive.ai/cli/iai_dataset-items) - Manage dataset items
* [iai dataset-runs](https://docs.interactive.ai/cli/iai_dataset-runs) - Manage dataset runs
* [iai datasets](https://docs.interactive.ai/cli/iai_datasets) - Manage evaluation datasets
* [iai glossaries](https://docs.interactive.ai/cli/iai_glossaries) - Manage glossary definitions
* [iai images](https://docs.interactive.ai/cli/iai_images) - Build and manage container images
* [iai login](https://docs.interactive.ai/cli/iai_login) - Log in to InteractiveAI
* [iai logout](https://docs.interactive.ai/cli/iai_logout) - Log out of InteractiveAI
* [iai macros](https://docs.interactive.ai/cli/iai_macros) - Manage macros
* [iai metrics](https://docs.interactive.ai/cli/iai_metrics) - Manage observability metrics
* [iai observations](https://docs.interactive.ai/cli/iai_observations) - Manage observations
* [iai organizations](https://docs.interactive.ai/cli/iai_organizations) - Manage organizations
* [iai policies](https://docs.interactive.ai/cli/iai_policies) - Manage policies
* [iai projects](https://docs.interactive.ai/cli/iai_projects) - Manage projects
* [iai prompts](https://docs.interactive.ai/cli/iai_prompts) - Manage prompts
* [iai queue-items](https://docs.interactive.ai/cli/iai_queue-items) - Manage annotation queue items
* [iai queues](https://docs.interactive.ai/cli/iai_queues) - Manage annotation queues
* [iai replicas](https://docs.interactive.ai/cli/iai_replicas) - Manage service replicas
* [iai routines](https://docs.interactive.ai/cli/iai_routines) - Manage routines
* [iai run-items](https://docs.interactive.ai/cli/iai_run-items) - Manage dataset run items
* [iai score-configs](https://docs.interactive.ai/cli/iai_score-configs) - Manage score configs
* [iai scores](https://docs.interactive.ai/cli/iai_scores) - Manage scores
* [iai secrets](https://docs.interactive.ai/cli/iai_secrets) - Manage secrets
* [iai services](https://docs.interactive.ai/cli/iai_services) - Manage services
* [iai sessions](https://docs.interactive.ai/cli/iai_sessions) - Manage sessions
* [iai stack](https://docs.interactive.ai/cli/iai_stack) - Manage stacks
* [iai traces](https://docs.interactive.ai/cli/iai_traces) - Manage traces
* [iai variables](https://docs.interactive.ai/cli/iai_variables) - Manage variables
* [iai vector-stores](https://docs.interactive.ai/cli/iai_vector-stores) - Manage vector stores