> ## Documentation Index
> Fetch the complete documentation index at: https://opencompass-docs-preview-pr-335-0.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` | Evaluate the selected benchmark with a specified model, harness, and environment. | [run](/en/user_guide/using_agentcompass/cli/run) |
| `agentcompass launch` | Coordinate multiple explicitly named evaluation requests with one scheduler. | [launch](/en/user_guide/using_agentcompass/cli/launch) |
| `agentcompass analysis` | Run post-execution analyzers over an existing result directory. | [analysis](/en/user_guide/using_agentcompass/cli/analysis) |
| `agentcompass summary` | Recompute benchmark aggregates and regenerate `summary.md` from existing task details. | [summary](/en/user_guide/using_agentcompass/cli/summary) |
| `agentcompass view` | Browse an existing result directory's metrics, tasks, and trajectories in a local browser. | [view](/en/user_guide/using_agentcompass/cli/view) |
| `agentcompass list` | Inspect registered benchmarks, harnesses, environments, analyzers, and protocol support. | [list](/en/user_guide/using_agentcompass/cli/list) |
| `agentcompass config` | Inspect values merged from configuration files or query component configuration fields. | [config](/en/user_guide/using_agentcompass/cli/config) |
| `agentcompass --version` | Print the installed AgentCompass version. | — |

## Choose `run` or `launch`

[`agentcompass run`](/en/user_guide/using_agentcompass/cli/run) evaluates a selected benchmark with the harness, model,
and environment supplied through the command line and configuration files. Positional arguments select the benchmark,
harness, and model in that order, while `--env` selects the environment. Component parameters, concurrency, retries, output, and
reuse settings come from the same command or the configuration files it loads.

[`agentcompass launch`](/en/user_guide/using_agentcompass/cli/launch) reads multiple explicitly named evaluation
requests from a YAML or JSON file and submits them to one global scheduler. Use it to compare models, run several
benchmarks, or mix harnesses and environments. It does not generate a Cartesian product automatically; declare every
combination explicitly in the orchestration file.

Both commands share the same configuration. See [Run Controls](/en/user_guide/using_agentcompass/run_controls) for scheduling and recovery, [Timeouts](/en/user_guide/using_agentcompass/timeouts) for time budgets, and [Save and Prepare Artifacts](/en/user_guide/using_agentcompass/artifacts) for task files.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.