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

# ChargerDojo documentation

> Automate ChargerDojo: register partner endpoints, run OCPI conformance suites and charging journeys, and read the graded reports.

[ChargerDojo](https://chargerdojo.com) tells you where your OCPI implementation departs
from the specification, and shows you the exchange that proves it. You can drive all of it in the browser;
these pages are for the parts you want to automate.

The end of a run looks like this:

```json theme={null}
{ "total": 51, "passed": 46, "failed": 2, "warned": 3, "unobservable": 3 }
```

Each of those two failures names the check, the rule it broke, and the request and response
that produced it. The three warnings are separate on purpose: they diverge from something the
spec only recommends, so they never fail a build. `total` is `passed + failed + unobservable`;
`warned` is counted separately and overlaps the others, so it is not a fourth bucket.

## Start here

<CardGroup cols={2}>
  <Card title="What is free" icon="gift" href="/guide/what-is-free">
    The sandbox, the simulator and the MCP server cost nothing. Where the paid line falls, and
    why.
  </Card>

  <Card title="Quickstart" icon="play" href="/guide/quickstart">
    One conformance run against the sandbox from the command line, start to verdict. Needs an
    API key.
  </Card>

  <Card title="Connect a coding agent" icon="robot" href="/guide/connect-a-coding-agent">
    Ask OCPI questions from Claude Code, Codex or Cursor. The question half needs no
    account.
  </Card>

  <Card title="Connect a partner" icon="plug" href="/guide/connect-a-partner">
    Point it at a real endpoint and run the suite against that instead.
  </Card>

  <Card title="Read your report" icon="list-check" href="/guide/read-your-report">
    What a failure is telling you, and what to change.
  </Card>

  <Card title="Run a charging journey" icon="route" href="/guide/run-a-charging-journey">
    Drive a full charging story over time and watch it live.
  </Card>

  <Card title="Plans and pricing" icon="tag" href="/guide/plans">
    What each plan costs, and the capability behind every line of the table.
  </Card>

  <Card title="Create an API key" icon="key" href="/guide/create-an-api-key">
    Needed once, before the API or your own account's data works from a terminal.
  </Card>

  <Card title="API reference" icon="book-open" href="/api">
    Every public operation, its authentication, and the response envelope.
  </Card>
</CardGroup>

## What is public

Only the operations in the **API reference** section are the public API. Everything else the
application does, including the interactive simulator, entity editing, and account and key
management, is browser functionality, not part of the automated contract.
