Skip to main content
Use this guide after completing the Quick Start. The starter command intentionally omits most options: AgentCompass fills them from built-in defaults, configuration files, selected component defaults, and compatible recipes. This page explains what those omitted values mean and how to override only the settings your evaluation needs. This page describes one agentcompass run request. To coordinate multiple benchmarks, models, harnesses, or environments with one scheduler, use agentcompass launch.

Evaluation Shape

Every run starts with three positional arguments and an environment selection:
Each part owns a different set of decisions:
Keep parameters with the component that owns the behavior. For example, task filters belong in --benchmark-params, agent step limits belong in --harness-params, and container resources belong in --env-params.

General Run Parameter Reference

The table below covers the complete agentcompass run command surface. “Built-in default” means the value used before user-level, project-level, or explicit configuration files override it. A conditional parameter is required only when the selected component or endpoint needs it.
Start from the minimal Get Started command and add only the parameters you need. Inspect the effective values before scaling a run instead of copying every default into the command line.

Component-Specific Parameters

The four JSON parameter flags do not share one schema. Their available fields and defaults depend on the selected component:

Choose What to Configure

Choose a Benchmark

Find supported datasets, benchmark-specific parameters, recommended harnesses, and minimal commands.

Choose a Harness

Compare direct model calls, coding agents, terminal agents, research agents, and specialized harnesses.

Choose an Environment

Select local Docker or a remote sandbox and configure credentials, resources, and network policies.

Configure a Model

Connect an OpenAI-compatible or Anthropic-compatible endpoint and pass generation parameters.

Control Task Execution

Tune concurrency, retries, timeouts, reuse, logging, and task lifecycle behavior.

Run Multiple Evaluations

Coordinate explicit model, benchmark, harness, or environment requests with one global scheduler.

Control Network Access

Configure setup, rollout, and verifier policies; build allowlists and verify isolation.

Inspect Results

Read per-task details and summaries, preserve reusable evidence, and analyze failures.

Troubleshoot a Run

Reduce a failure to one task, locate its lifecycle phase, and apply the correct fix.

Configuration Files and Precedence

CLI flags are best for one run. Configuration files are useful when the same defaults must be shared across commands, machines, or a project. They are override layers rather than a second execution interface: the same benchmark, harness, environment, runtime, and execution settings remain in effect.

Choose a Configuration Layer

AgentCompass loads the user-level file first, then the project-level file. Repeat --config to add run-specific files in command order:

Inspect or Generate Configuration

config show prints the merged runtime and execution values. Add component selectors to include the defaults for a particular benchmark, harness, and environment, then redirect the result when you want an editable template:
config show answers “what value will be used?” For the meaning and accepted values of a component field, use its module page or inspect the live component schema:

Override Order

When the same field appears in more than one place, AgentCompass resolves it in this order, from lowest to highest priority:
  1. Built-in runtime, execution, and component defaults.
  2. ~/.config/agentcompass/config.yaml.
  3. <repo-root>/config.yaml.
  4. Explicit --config files, in command order.
  5. Supported runtime environment overrides, such as AGENTCOMPASS_AUTO_INSTALL_DEPENDENCIES.
  6. CLI flags, Python SDK arguments, --benchmark-params, --harness-params, and --env-params.
  7. Compatible recipe adaptation, while preserving explicit user overrides.

Secrets

Prefer environment variables for API keys, tokens, and private endpoints. Common variables include MODEL_NAME, MODEL_BASE_URL, MODEL_API_KEY, DAYTONA_API_KEY, MODAL_TOKEN_ID, and MODAL_TOKEN_SECRET. Do not commit secrets to project configuration files.
  1. Select a benchmark and start with one known task through sample_ids.
  2. Use the benchmark’s recommended harness before trying alternative harnesses.
  3. Confirm the model protocol and endpoint with low concurrency.
  4. Select an environment that supports the benchmark’s task image and isolation requirements.
  5. Inspect per-task results and errors before scaling to the complete dataset.
  6. Increase concurrency gradually within model endpoint and environment provider limits.
  7. Use result reuse and post-analysis for interrupted runs and failure diagnosis.
The CLI and Python SDK expose the same evaluation model. Choose the interface that best fits your workflow.