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.
- Additional permissions or credentials when using model execution, connector OAuth, or Git synchronization.
Install the CLI
Install the CLI globally using npm: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:
/api, /runtime, or /search unless your administrator explicitly provides URLs that require them.
You can also configure the service URLs using environment variables:
Authenticate
Sign in to Platform using the device authorization flow: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.
Select a workspace and project
List and select the workspace you want to work in:--project <project-id> whenever the command supports it.
Once the CLI is installed, connected, and authenticated, continue to Use the Artemis Platform CLI to create, review, customize, test, and deploy agents.