@koredev/artemis-platform-cli

v1.0.0-rc.20260824075514

Published

a month ago

Artemis Platform CLI for creating, debugging, deploying, and managing agent projects

Downloads

363

0High
0Medium
0Low

sathishrambathini-kore

arch kore agent abl cli debug

Artemis Platform CLI

Manage Kore Platform agent projects from your terminal or CI pipeline.

Use the CLI to create and update projects, author and test agents, connect enterprise content, validate project packages, run evaluations, synchronize with Git, automate lifecycle workflows, and use Arch AI without opening the browser. The same commands work for interactive development and repeatable automation.

This guide is for agent developers, project administrators, and teams building Kore Platform projects.

The CLI is in its early stages and will continue to evolve with additional features and platform capabilities. Review release notes and validate release candidates in a non-production project before adopting them broadly.

Check artemis-platform-cli --version after installation. Versions containing -rc. are release candidates and should be validated in a non-production project before wider use.

Requirements

Node.js 22 or newer
A Kore Platform account with access to the workspace and project you want to manage
The platform URL(s) provided by your Kore Platform administrator
Additional permissions or credentials when using model execution, connector OAuth, or Git synchronization

Install

Install the CLI globally:

npm install --global @koredev/artemis-platform-cli
artemis-platform-cli --version
artemis-platform-cli --help

To try a release candidate before the next stable release, install the RC package explicitly:

npm install --global @koredev/artemis-platform-cli@<version>-rc.<timestamp>
artemis-platform-cli --version

Release candidates should be tested in a non-production project. They are published separately from the stable @koredev/artemis-platform-cli package.

Pin the CLI in a project when reproducible automation is important:

npm install --save-dev @koredev/artemis-platform-cli
npx artemis-platform-cli --version

Upgrade or remove a global installation:

npm update --global @koredev/artemis-platform-cli
npm uninstall --global @koredev/artemis-platform-cli

Quick Start

1. Connect to your Kore Platform environment

apiUrl is the base URL for your Kore Platform environment. In most deployments, apiUrl, runtimeApiUrl, and searchAiApiUrl use the same base domain because a gateway routes requests to the appropriate service. The standard Kore.ai production domain is shown below as an example:

artemis-platform-cli config set apiUrl https://agents.kore.ai
artemis-platform-cli config set runtimeApiUrl https://agents.kore.ai
artemis-platform-cli config set searchAiApiUrl https://agents.kore.ai
artemis-platform-cli config show

For a private, regional, or separately routed deployment, replace the example with the base URL supplied by your Kore Platform administrator. The service URLs can be different when Runtime or SearchAI is exposed on its own host:

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

Do not append paths such as /api, /runtime, or /search unless your administrator explicitly provides URLs that require them.

You can also configure URLs with environment variables:

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.

2. Sign in

artemis-platform-cli login
artemis-platform-cli whoami

login opens the Kore Platform device authorization flow. Complete the browser step using an account with access to the workspace and project you intend to manage.

3. Select a workspace and project

artemis-platform-cli workspaces list
artemis-platform-cli workspaces select <workspace-id>

artemis-platform-cli projects list
artemis-platform-cli projects select <project-slug>
artemis-platform-cli projects current

Interactive commands use the selected project. In CI, prefer an explicit --project <project-id> whenever the command supports it.

Create and Manage a Project

Create a project:

artemis-platform-cli projects create "Support Automation" \
  --description "Customer support agents and workflows"

artemis-platform-cli projects list
artemis-platform-cli projects select <project-slug>

Create an agent from an ABL file, inspect it, and compile it:

artemis-platform-cli agents create support_agent \
  --file ./agents/support.agent.abl

artemis-platform-cli agents get support_agent
artemis-platform-cli agents compile support_agent

Update the agent and read it back:

artemis-platform-cli agents update support_agent \
  --file ./agents/support-v2.agent.abl

artemis-platform-cli agents get support_agent

Create an HTTP tool:

artemis-platform-cli tools create lookup_order \
  --description "Look up an order by ID" \
  --type http \
  --endpoint https://api.example.com/orders/lookup \
  --method POST \
  --file ./tools/lookup-order.tools.abl

artemis-platform-cli tools get lookup_order

Agent execution requires a working primary model connection:

artemis-platform-cli models list
artemis-platform-cli models test <model-id>
artemis-platform-cli agents test support_agent \
  --message "Check order CERT-1001"

If model testing fails, ask a tenant administrator to configure and select a primary model before retrying agent, eval, or Arch generation commands.

Enterprise Connectors

Connectors ingest enterprise content into a SearchAI index. Create commands vary by connector type; inspect the current options first:

artemis-platform-cli connector create --help

For example, create and authenticate a SharePoint connector:

artemis-platform-cli connector create sharepoint "Support Knowledge" \
  --index-id <index-id> \
  --tenant-url https://<tenant>.sharepoint.com \
  --client-id <azure-application-id>

artemis-platform-cli connector auth <connector-id>

After completing OAuth, start a full synchronization and inspect its status:

artemis-platform-cli connector sync start <connector-id>
artemis-platform-cli connector sync status <connector-id>

Run an incremental synchronization after the first full sync:

artemis-platform-cli connector sync start <connector-id> --delta
artemis-platform-cli connector sync status <connector-id>

Use connector filter --help and connector permission --help to control the content scope and permission mode before production ingestion.

Export, Verify, and Import Projects

Export all supported project layers:

artemis-platform-cli export \
  --project <project-id> \
  --output ./exports \
  --all-layers \
  --include-deployments

Verify the exported files locally:

artemis-platform-cli verify ./exports/<project-slug>
artemis-platform-cli lockfile recompute ./exports/<project-slug> --check

Preview an import before applying it:

artemis-platform-cli import ./exports/<project-slug> \
  --project <project-id> \
  --dry-run

Review the preview, then apply and run post-import checks:

artemis-platform-cli import ./exports/<project-slug> \
  --project <project-id> \
  --acknowledge-warnings

artemis-platform-cli doctor --project <project-id>

Do not acknowledge warnings until you understand the proposed changes. Use a dedicated project when evaluating an unfamiliar package.

Git Synchronization

Git operations require a project-shared authentication profile created by a platform administrator.

artemis-platform-cli git init \
  --project <project-id> \
  --provider bitbucket \
  --repo <repository-url> \
  --auth-profile <profile-id> \
  --branch main \
  --sync-path /artemis

artemis-platform-cli git status --project <project-id>

Push project state:

artemis-platform-cli git push \
  --project <project-id> \
  --branch main \
  --message "Update Artemis project"

Preview a pull before applying it:

artemis-platform-cli git pull --project <project-id> --branch main
artemis-platform-cli git pull --project <project-id> --branch main --apply

Lifecycle Automation

The lifecycle command tree is designed for CI and release automation. Each invocation writes exactly one versioned JSON envelope to stdout and returns a stable exit code.

A typical flow is:

artemis-platform-cli lifecycle validate ./exports/<project-slug> \
  --project <project-id> \
  --preview

artemis-platform-cli lifecycle sync ./exports/<project-slug> \
  --project <project-id>

artemis-platform-cli lifecycle eval run \
  --project <project-id> \
  --set <eval-set-id> \
  --wait \
  --min-pass-rate 0.90 \
  --min-score 0.80

Continue with release publication, deployment, and evidence only after the validation, sync preview, and eval gate succeed.

See the Lifecycle CLI Guide for a complete CI flow, safe sync apply, deployment transitions, evidence generation, and exit codes.

Arch AI from the Terminal

Start an onboarding session or open a session for an existing project:

artemis-platform-cli arch session new
artemis-platform-cli arch session new --project <project-id>
artemis-platform-cli arch session list

Send one request or enter interactive chat:

artemis-platform-cli arch send \
  "Add order-status support and update the project"

artemis-platform-cli arch chat

Inspect the resulting project state:

artemis-platform-cli arch summary --project <project-id>
artemis-platform-cli arch health --project <project-id>

Arch generation requires a configured primary model. A session can exist even when the tenant is not yet configured for generation.

MCP Integration

Start the CLI as an MCP stdio server:

artemis-platform-cli mcp

Example MCP client configuration:

{
  "mcpServers": {
    "artemis-platform": {
      "command": "artemis-platform-cli",
      "args": ["mcp"],
      "env": {
        "KORE_API_URL": "https://agents.kore.ai",
        "KORE_RUNTIME_API_URL": "https://agents.kore.ai",
        "KORE_SEARCHAI_API_URL": "https://agents.kore.ai"
      }
    }
  }
}

Desktop MCP clients may not inherit your terminal PATH. If the process cannot be launched, replace artemis-platform-cli with the absolute binary path from:

command -v artemis-platform-cli

The MCP process uses the same stored login, selected workspace, selected project, and service URLs as direct CLI commands. Keep stdout reserved for MCP JSON-RPC messages.

CI Authentication and Isolated State

CI jobs can provide a user access token without writing it to CLI storage:

export KORE_API_TOKEN='<user-access-token>'

Store the token in your CI secret manager. Never place it in command arguments, committed scripts, build logs, or documentation.

To isolate CLI state for a job:

export ARTEMIS_PLATFORM_CLI_CONFIG_DIR="$(mktemp -d)"

The directory must be an absolute path. Remove it when the job finishes.

Command Map

| Command | Purpose | | -------------------------------------------------- | ------------------------------------------------------------- | | login, logout, whoami | Authenticate and inspect identity | | workspaces, projects | Select and manage context | | agents, tools, models | Author, compile, and test agent resources | | connector | Configure and synchronize enterprise content | | export, import, verify, doctor, lockfile | Move and validate project packages | | git | Synchronize project state with a Git repository | | lifecycle | Run machine-readable eval, release, and deployment automation | | arch | Use Arch AI without the browser | | mcp | Expose platform capabilities over MCP stdio | | config | Manage service URLs and inspect local state paths |

The installed command help is the syntax source of truth:

artemis-platform-cli --help
artemis-platform-cli <command> --help
artemis-platform-cli <command> <subcommand> --help

Safety

Use explicit project IDs in automation.
Read previews before applying imports, syncs, or Git pulls.
Do not bypass qualification gates without an approval record and reason.
Do not retry an OUTCOME_UNKNOWN mutation blindly; read authoritative state first.
Keep API tokens, OAuth credentials, provider keys, and Git credentials out of command arguments and logs.
Use non-production projects and repositories when evaluating a release candidate.

Troubleshooting

| Problem | Resolution | | ----------------------------------- | -------------------------------------------------------------------------------------------- | | Not authenticated | Run login, then confirm with whoami. In CI, check KORE_API_TOKEN. | | No active project | Run projects select <slug> or provide --project <id>. | | Connector commands return 404 | Check searchAiApiUrl or KORE_SEARCHAI_API_URL. | | No API key configured | Ask an administrator to configure and select a tenant primary model. | | Connector is not authenticated | Run connector auth <connector-id> and complete OAuth. | | No git integration configured | Create an authorized Git profile, then run git init. | | IMPORT_PREVIEW_STALE | Generate a new preview and use its new digest. | | OUTCOME_UNKNOWN | Read the affected resource with get, list, or status before deciding whether to retry. | | MCP client cannot start the command | Configure the absolute binary path returned by command -v. |

For configuration paths and active URL values, run:

artemis-platform-cli config show