Artemis CLI

Command-line interface for interacting with the Artemis platform.

The Artemis CLI provides a powerful way to manage your Artemis projects, tasks, and optimizations directly from the terminal. It supports all major operations including project management, task execution, and monitoring.

---

Install the Artemis CLI

Download and install the CLI for your platform.

Prerequisites

• macOS, Linux, or Windows
• Internet connection for download and API access

Quickstart

You must be using a bash shell on macOS or Linux, or Powershell 5.0+ on Windows to run these commands.

1. Download and execute the installer

Production:

curl -L --digest -u "Artemis_User:Artemis_Custom_Runner_2025" \
  "https://files.artemis.turintech.ai/artemis-cli/prod/artemis-cli-installer.sh" \
  -o installer.sh && chmod +x installer.sh && ./installer.sh --env prod

Staging:
curl -L --digest -u "Artemis_User:Artemis_Custom_Runner_2025" \
  "https://files.artemis.turintech.ai/artemis-cli/stg/artemis-cli-installer.sh" \
  -o installer.sh && chmod +x installer.sh && ./installer.sh

Development:
curl -L --digest -u "Artemis_User:Artemis_Custom_Runner_2025" \
  "https://files.artemis.turintech.ai/artemis-cli/dev/artemis-cli-installer.sh" \
  -o installer.sh && chmod +x installer.sh && ./installer.sh --env dev

2. Configure your API key

Set your Artemis API key to authenticate with the platform:

artemis config set ARTEMIS_API_KEY <your-api-key>

3. Verify installation

artemis status

---
Common Commands

| Command                  | Description                 |
|--------------------------|-----------------------------|
| artemis project list     | List all your projects      |
| artemis project get <id> | Get project details         |
| artemis task list        | List tasks for a project    |
| artemis task start       | Start an optimization task  |
| artemis task get <id>    | Get task status             |
| artemis config           | View current configuration  |
| artemis --help           | Show all available commands |

---
Configuration

The CLI can be configured via environment variables or the config command:

| Setting                | Description                           |
|------------------------|---------------------------------------|
| ARTEMIS_API_KEY        | Your API key for authentication       |
| ARTEMIS_TIMEOUT        | Request timeout (default: 30s)        |
| ARTEMIS_RETRY_ATTEMPTS | Number of retry attempts (default: 3) |

---
Need help? Run artemis --help or check our documentation.