> ## Documentation Index
> Fetch the complete documentation index at: https://koreai.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Install the Artemis Platform CLI

The Artemis Platform CLI lets you build and manage Agent Platform projects from your terminal or CI pipeline. CLI lets developers automate the complete agentic lifecycle, including authentication, project sync, eval runs, and deployment, from external systems, without Studio.

To create, review, customize, test, and deploy agents with the CLI, see [Use the Artemis Platform CLI](/agent-platform/use-cli).

## Prerequisites

* Node.js 22 or later.
* An **Agent Platform account** with access to the workspace and project you want to manage.
* The **Platform URL** provided by your platform administrator. For hosted solution, it's a [region-specific platform URL](/agent-platform/getting-started#platform-access-and-allowlist-of-ips).
* Additional permissions or credentials when using model execution, connector OAuth, or Git synchronization.

## Install the CLI

Install the CLI globally using npm:

```bash theme={null}
npm install --global @koreai/artemis-platform-cli
artemis-platform-cli --version
artemis-platform-cli --help
```

To use the CLI as a project dependency, install it as a development dependency:

```bash theme={null}
npm install --save-dev @koreai/artemis-platform-cli
npx artemis-platform-cli --version
```

To upgrade or remove a global installation:

```bash theme={null}
npm update --global @koreai/artemis-platform-cli
npm uninstall --global @koreai/artemis-platform-cli
```

### Install a release candidate (RC) build

Versions containing `-rc.` are release candidates, published separately from the stable `@koreai/artemis-platform-cli` package. Release candidates build are for testing only and you must use those in a non-production project.

To try a release candidate (RC) build before its stable release, explicitly install the RC package using the command `npm install --global @koredev/artemis-platform-cli@<version>-rc.<timestamp>`. After installation, verify the version using the command `artemis-platform-cli --version`.

## Connect to Agent Platform

Before using the CLI, configure the URLs for the Platform services. In most deployments, `apiUrl`, `runtimeApiUrl`, and `searchAiApiUrl` use the same base domain.

For example:

```bash theme={null}
artemis-platform-cli config set apiUrl https://platform.example.com
artemis-platform-cli config set runtimeApiUrl https://runtime.example.com
artemis-platform-cli config set searchAiApiUrl https://search.example.com
artemis-platform-cli config show
```

For a private, regional, or a separately-routed deployment, use the base URLs provided by your platform administrator. For hosted solution, it's a [region-specific platform URL](/agent-platform/getting-started#platform-access-and-allowlist-of-ips).

Don't append paths such as `/api`, `/runtime`, or `/search` unless your administrator explicitly provides URLs that require them.

You can also configure the service URLs using environment variables:

```bash theme={null}
export KORE_API_URL=https://agents.kore.ai
export KORE_RUNTIME_API_URL=https://agents.kore.ai
export KORE_SEARCHAI_API_URL=https://agents.kore.ai
```

Environment variables override stored URL settings for the current process.

## Authenticate

Sign in to Platform using the device authorization flow:

```bash theme={null}
artemis-platform-cli login
artemis-platform-cli whoami
```

The `login` command opens the device authorization flow in your browser. Complete the browser step using an account that has access to the workspace and project you want to manage.

For CI pipelines, provide an access token instead of signing in interactively. See [Use the CLI in CI](/agent-platform/use-cli#use-the-cli-in-ci).

## Select a workspace and project

List and select the workspace you want to work in:

```bash theme={null}
artemis-platform-cli workspaces list
artemis-platform-cli workspaces select <workspace-id>
```

List and select a project:

```bash theme={null}
artemis-platform-cli projects list
artemis-platform-cli projects select <project-slug>
artemis-platform-cli projects current
```

Interactive commands use the selected project. For CI workflows, use an explicit `--project <project-id>` whenever the command supports it.

Once the CLI is installed, connected, and authenticated, continue to [Use the Artemis Platform CLI](/agent-platform/use-cli) to create, review, customize, test, and deploy agents.