Skip to content
Get started

How To Use Overmind

Step-by-step guide to run your first Overmind optimization loop.

Overmind is the fastest way to improve an existing Python agent with measurable, regression-aware changes.

Terminal window
pip install overmind

From your agent project root:

Terminal window
overmind init

This creates .overmind/ and collects required API keys and model defaults.

Terminal window
overmind agent register my-agent agents.my_agent:run

Your entrypoint should accept a dictionary input and return a dictionary output.

Terminal window
overmind setup my-agent

You can also bring your own policy document:

Terminal window
overmind setup my-agent --policy docs/my_policy.md
Terminal window
overmind optimize my-agent

Overmind will:

  1. run your agent against a dataset
  2. trace and score outputs
  3. generate candidate fixes
  4. keep only changes that improve results

Results are written to:

  • .overmind/agents/<name>/setup_spec/
  • .overmind/agents/<name>/experiments/

You can inspect report.md, review diffs, and continue iterating.