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

# Command-Line Interface

> Choose the AgentCompass command for running, orchestrating, summarizing, analyzing, and inspecting evaluations.

AgentCompass exposes one console script, `agentcompass`. Run it from an activated AgentCompass environment or through
`uv run`:

```bash theme={"system"}
agentcompass --help
```

```bash theme={"system"}
uv run agentcompass --help
```

## Command List

| Command                  | Use it when                                                                                            | Detailed guide                          |
| ------------------------ | ------------------------------------------------------------------------------------------------------ | --------------------------------------- |
| `agentcompass run`       | Execute one model, benchmark, harness, and environment request containing one or many benchmark tasks. | [run](/en/user_guide/cli/run)           |
| `agentcompass launch`    | Coordinate multiple explicitly named evaluation requests with one scheduler.                           | [launch](/en/user_guide/cli/launch)     |
| `agentcompass analysis`  | Run post-execution analyzers over an existing result directory.                                        | [analysis](/en/user_guide/cli/analysis) |
| `agentcompass summary`   | Recompute benchmark aggregates and regenerate `summary.md` from existing task details.                 | [summary](/en/user_guide/cli/summary)   |
| `agentcompass list`      | Inspect registered benchmarks, harnesses, environments, analyzers, and protocol support.               | [list](/en/user_guide/cli/list)         |
| `agentcompass config`    | Inspect effective configuration and live component parameter schemas.                                  | [config](/en/user_guide/cli/config)     |
| `agentcompass --version` | Print the installed AgentCompass version.                                                              | —                                       |

## Choose `run` or `launch`

The distinction is between evaluation requests, not benchmark tasks:

```text theme={"system"}
one model + one benchmark + one harness + one environment
                              ↓
                       agentcompass run
                              ↓
                  one or many benchmark tasks

multiple explicitly named combinations
                              ↓
                     agentcompass launch
                              ↓
              one shared orchestration scheduler
```

Use `run` for a normal evaluation, including a complete benchmark with hundreds of tasks. Use `launch` only when one
operation must coordinate several model/benchmark/harness/environment combinations.

## Shared CLI Rules

* Run `agentcompass <command> --help` against the installed revision for the authoritative option list.
* JSON flags such as `--benchmark-params`, `--harness-params`, `--env-params`, `--model-params`, and
  `--analysis-params` must contain valid JSON objects.
* Prefer environment variables for credentials and private endpoint values.
* Explicit command-line values override matching configuration-file values.
* Persistent run logs may be more verbose than the console because `--log-level` and `--file-log-level` are separate.
* Use [Troubleshooting Runs](/en/user_guide/troubleshooting) when a command reaches task execution but fails in a
  model, benchmark, harness, environment, or verification phase.

The [General Run Parameter Reference](/en/user_guide/overview#general-run-parameter-reference) explains parameters
shared by evaluations. Component-owned JSON fields remain on their model, benchmark, harness, and environment pages.