# Autonoma Environment Factory SDK

> This package implements the Autonoma Environment Factory: a single backend endpoint that creates isolated, factory-driven test data before an end-to-end test run and tears it down afterward. These docs are bundled inside the installed package so a coding agent can read the API that matches this exact version, instead of relying on training data.

If you are setting up the endpoint, read `implement.md` and follow it step by step. The other files are reference.

## Reading order

1. overview.md - What the Environment Factory is, the three actions (discover/up/down), the scope field, the two secrets, and why it is factory-driven. Start here.
2. implement.md - Step-by-step setup for this language: install, register factories, wire the handler, implement the auth callback, enable the endpoint, and validate. This is the doc to follow when integrating.
3. factories.md - How to write a factory in this language: the `create`/`teardown` contract, the input schema, and what `create` receives and must return.
4. scenarios.md - The `create` data format: the flat map, `_alias`/`_ref` links, the scope field, and the three standard scenarios. Language-agnostic.
5. protocol.md - The HTTP wire protocol: authentication, the three actions, the refs token, the safety model, and every error code. Language-agnostic. Reach for this when debugging.
6. validation.md - How to dry-run a scenario against a real database in this language before deploying.