> ## 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.

# agentcompass summary

`agentcompass summary` recomputes Benchmark aggregate metrics from task results in an existing run directory and
updates the metric files and their provenance. It does not rerun agents, verifiers, or analyzers.

```bash theme={"system"}
agentcompass summary [OPTIONS] RUN-DIR
```

## Regenerate a Summary

`RUN-DIR` should point to the complete AgentCompass [result directory](/en/user_guide/other_features/results/overview#directory-layout),
not its `details/` subdirectory:

```bash theme={"system"}
agentcompass summary \
  results/my-model_swebench_verified_mini_swe_agent/20260703_120000
```

AgentCompass strictly validates saved task details and the attempt plan in `run_info.json`, then rebuilds one Metric Contract report. By default, it replaces `summary.md` and `metrics.json` in place without modifying task results, and records `source: "summary"` plus the report plan under `run_info.json.metric_artifacts`.

## Preview the Summary

Use `--dry-run` to preview the new `summary.md` in the terminal before writing files:

```bash theme={"system"}
agentcompass summary \
  results/my-model_swebench_verified_mini_swe_agent/20260703_120000 \
  --dry-run
```

This mode does not update any files in the run directory.

## Parameters

| Parameter | Required? | Default | Purpose |
| - | - | - | - |
| `RUN-DIR` / `--run-dir` | Required | None | Selects an existing AgentCompass run directory. |
| `--config <path>` | Optional | None | Loads a YAML or JSON file that supplements benchmark configuration; repeatable. Persisted parameters with the same keys take precedence. |
| `--benchmark-params <json>` | Optional | None | Uses a JSON object to override benchmark parameters recovered from the run directory. |
| `--dry-run` | Optional | Disabled | Prints the regenerated Markdown to the terminal without writing files. |

You normally do not need `--config` or `--benchmark-params`. Use them only to supply or adjust current Benchmark aggregation settings such as `aggregation_mode` or `category_hierarchy`. They cannot change the persisted `execution.attempts` plan and do not reevaluate tasks. In a non-dry-run regeneration, `metric_artifacts.benchmark_params_override` stores the redacted `--benchmark-params` object; the original request and `params.json` remain unchanged.

## Related Pages

* [Metrics and Aggregation](/en/user_guide/other_features/results/metrics_aggregation)
* [Summary and Analysis Results](/en/user_guide/other_features/results/summary_analysis)
* [`agentcompass analysis`](/en/user_guide/using_agentcompass/cli/analysis)
* [`agentcompass config`](/en/user_guide/using_agentcompass/cli/config)
* [CLI Overview](/en/user_guide/using_agentcompass/cli/overview)


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