> ## Documentation Index
> Fetch the complete documentation index at: https://docs.egma.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Egma: Open-Source Simulation Testing for Voice Agents

> Test, monitor, and improve your voice agents with Egma's platform for simulation testing, production telemetry, and automated verdict grading.

Egma is the open-source platform purpose-built for teams shipping voice agents. It lets you simulate real conversations before they reach production, monitor live calls through OpenTelemetry, and automatically grade every exchange against the behaviors you expect — so you ship with confidence rather than guesswork.

<CardGroup cols={2}>
  <Card title="Introduction" icon="book-open" href="/introduction">
    Learn what Egma is, how it works, and which platforms it integrates with.
  </Card>

  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Run your first simulation test in minutes using the Egma CLI wizard.
  </Card>

  <Card title="CLI Reference" icon="terminal" href="/cli/overview">
    Every command, option, and exit code the Egma CLI exposes.
  </Card>

  <Card title="API Reference" icon="code" href="/api/overview">
    REST endpoints for traces, runs, verdicts, and platform configuration.
  </Card>
</CardGroup>

## Get up and running

<Steps>
  <Step title="Install the CLI">
    Run the Egma wizard from your voice agent's repository. No global install required — `npx` handles it.

    ```bash theme={null}
    npx @egma/cli
    ```
  </Step>

  <Step title="Connect your agent">
    Egma signs this machine in with a short browser approval, then asks for your Retell or LiveKit credentials to register your agent. Your key is sent once, sealed on the platform, and never written to a file.

    ```bash theme={null}
    egma connect
    ```
  </Step>

  <Step title="Write tests">
    The wizard drives your existing coding agent to read your repository and generate a first suite of test files in `egma/tests/`. Each test describes a scenario and the behaviors your agent should demonstrate.

    ```bash theme={null}
    egma init
    ```
  </Step>

  <Step title="Run tests">
    Push your tests to Egma and start a run. The simulator conducts real conversations with your agent; the grader writes one verdict per expected behavior as each call finishes.

    ```bash theme={null}
    egma run
    ```
  </Step>
</Steps>

## Key integrations

<CardGroup cols={2}>
  <Card title="Retell" icon="phone" href="/integrations/retell">
    Test Retell voice agents over text or phone, with your live prompt and tools.
  </Card>

  <Card title="Python SDK" icon="python" href="/integrations/python-sdk">
    Install the Egma SDK in your LiveKit agent to handle tool mocking during simulations.
  </Card>
</CardGroup>
