# Autonoma Docs

> Documentation for Autonoma's agentic end-to-end testing platform.

## Pages

- [Introduction](https://docs.autonoma.app/llms/index.txt): Autonoma is an agentic end-to-end testing platform. Connect your repo and every pull request gets reviewed automatically on a live preview environment - no test scripts to write or maintain.
- [Troubleshooting](https://docs.autonoma.app/llms/troubleshooting.txt): The questions people actually hit - what Autonoma supports and does not, why setup stalls, why a run has not started, how credits and billing work, and what we do with your code and data.
- [Preview environments](https://docs.autonoma.app/llms/preview-environments.txt): Vercel-style preview environments for every pull request. Configure your stack in the Autonoma dashboard, open a PR, get a live URL.
- [Use your own deploys](https://docs.autonoma.app/llms/preview-environments/your-own-deploys.txt): Connect the preview environments your pipeline already builds. Autonoma deploys nothing - your pipeline makes one signed call when a preview is live, and Autonoma runs its tests against that URL.
- [Apps and builds](https://docs.autonoma.app/llms/preview-environments/apps.txt): How Autonoma turns each app in your repo into a running container - the build method, the runtime catalog, build context, and the per-app settings.
- [Databases](https://docs.autonoma.app/llms/preview-environments/databases.txt): Add every database your preview needs - Postgres, MySQL, MongoDB, Redis / Valkey - each with its own engine, version, and repo-aware setup tasks for schema, seed data, and migrations.
- [Extra services](https://docs.autonoma.app/llms/preview-environments/services.txt): Run non-database side containers - MinIO, a mock API server, a Mailpit inbox, an OTel collector - alongside your app in every preview. Optional, and only needed when your app depends on one.
- [Connections](https://docs.autonoma.app/llms/preview-environments/connections.txt): Wire your apps to the databases, services, and other apps inside a preview with templated env vars that resolve at deploy time.
- [Lifecycle hooks](https://docs.autonoma.app/llms/preview-environments/hooks.txt): Commands that run around each deploy of the whole preview - pre-deploy before your apps start, post-deploy once they're ready.
- [Multiple repositories](https://docs.autonoma.app/llms/preview-environments/multirepo.txt): Deploy your frontend and the apps it depends on from more than one repository into a single preview, and control which branch of each connected repository gets built.
- [Your team and organizations](https://docs.autonoma.app/llms/organization/members.txt): How people get into an Autonoma organization - automatic joining by email domain, or an invitation - plus how an account can belong to several organizations, how switching between them works, and when leaving one is refused.
- [Connect your coding agent (MCP)](https://docs.autonoma.app/llms/mcp.txt): Install Autonoma's MCP server in your coding agent once, and use it for both jobs - setting an app up on Autonoma, and fixing what Autonoma flags on a pull request from inside your repo.
- [Set up a preview with a coding agent (MCP)](https://docs.autonoma.app/llms/mcp/configure-preview.txt): Autonoma gives you one command that registers this MCP with your coding agent and starts it on your whole setup - picking how your app gets its previews, configuring and deploying it or wiring your own pipeline, validating your SDK endpoint, and getting your scenario recipes provisioning - while you watch read-only in Autonoma. Hosted agents and CI run the same command with `--non-interactive`.
- [Suite health](https://docs.autonoma.app/llms/suite-health.txt): The five-state signal on your application's pull request list - what each level means, exactly how the score is calculated from your analysis runs, and why every new app starts at Calibrating rather than at zero or at green.
- [Fixing a degraded suite](https://docs.autonoma.app/llms/suite-health/fixing.txt): Hand every unresolved Autonoma failure to your coding agent in one prompt - how the Fix it button works, where each kind of fix actually lives, and why fixing one shared cause usually clears most of the backlog.
- [Test Planner](https://docs.autonoma.app/llms/test-planner.txt): The planner CLI is how you set Autonoma up. One command sets up your preview environment, generates your end-to-end test suite, wires the SDK and proves your test data - interactively, or unattended with `--non-interactive` for a hosted agent or a CI job.
- [Environment Factory](https://docs.autonoma.app/llms/environment-factory.txt): The Environment Factory is one endpoint in your backend that creates isolated test data before each test run and deletes it after - by reusing the real functions your app already uses to create that data.
- [Setup Guide](https://docs.autonoma.app/llms/environment-factory/setup.txt): Install the Autonoma SDK, create the Environment Factory endpoint, register factories, and wire up authentication - from an empty backend to a validated, production-ready endpoint.
- [Factories & the Create Payload](https://docs.autonoma.app/llms/environment-factory/factories.txt): How to register factories, link records with _alias and _ref, and tear down dependent rows. The factory is the only way the SDK writes data - there is no raw-SQL fallback.
- [Authentication](https://docs.autonoma.app/llms/environment-factory/authentication.txt): The auth callback turns a created User into real, working credentials the test runner uses to log in. Covers session cookies, bearer tokens, and email/password credentials for mobile.
- [Security & Troubleshooting](https://docs.autonoma.app/llms/environment-factory/security.txt): The Environment Factory's two secrets, three security layers, and hard safety guarantees - plus a full reference of error codes and common fixes.
- [Examples](https://docs.autonoma.app/llms/environment-factory/examples.txt): Working Environment Factory endpoints across 8 languages and 12 framework combinations - copy one for your stack.
- [TypeScript](https://docs.autonoma.app/llms/environment-factory/examples/typescript.txt): Autonoma Environment Factory examples with Express, Hono, and Next.js.
- [Python](https://docs.autonoma.app/llms/environment-factory/examples/python.txt): Autonoma Environment Factory examples with FastAPI, Flask, and Django.
- [Elixir](https://docs.autonoma.app/llms/environment-factory/examples/elixir.txt): Autonoma Environment Factory example with Phoenix.
- [Java](https://docs.autonoma.app/llms/environment-factory/examples/java.txt): Autonoma Environment Factory example with Spring Boot.
- [Ruby](https://docs.autonoma.app/llms/environment-factory/examples/ruby.txt): Autonoma Environment Factory example with Rails.
- [Rust](https://docs.autonoma.app/llms/environment-factory/examples/rust.txt): Autonoma Environment Factory example with Axum.
- [Go](https://docs.autonoma.app/llms/environment-factory/examples/go.txt): Autonoma Environment Factory example with Gin.
- [PHP](https://docs.autonoma.app/llms/environment-factory/examples/php.txt): Autonoma Environment Factory example with Laravel.
- [Secrets](https://docs.autonoma.app/llms/preview-environments/secrets.txt): How to give your preview apps the credentials they need - API keys, database URLs, tokens - without committing them, and how the platform stores and injects them.
- [Scenario Recipe Schema](https://docs.autonoma.app/llms/reference/scenario-recipe-schema.txt): Canonical JSON contract for the scenario recipes file uploaded to Autonoma at POST /v1/setup/setups/:id/scenario-recipe-versions.
- [Development Setup](https://docs.autonoma.app/llms/development/setup.txt): How to get Autonoma AI running locally - from prerequisites through a working dev environment.
- [Architecture Overview](https://docs.autonoma.app/llms/development/architecture.txt): High-level architecture of Autonoma AI - how the monorepo is organized, how data flows, and why each technology was chosen.
- [Package Guide](https://docs.autonoma.app/llms/development/packages.txt): What each package and app does, what it exports, and when you would modify it.
- [Code Conventions](https://docs.autonoma.app/llms/development/conventions.txt): The rules of the Autonoma AI codebase - TypeScript patterns, error handling, logging, testing, and style guidelines.
- [Common Workflows](https://docs.autonoma.app/llms/development/workflows.txt): Step-by-step guides for common development tasks - adding routes, pages, commands, models, tests, and more.
- [Environment Variables](https://docs.autonoma.app/llms/development/environment-variables.txt): Complete reference for every environment variable used across the Autonoma AI monorepo - API server, frontend, AI services, database, storage, logging, billing, and infrastructure.
- [Execution Agent](https://docs.autonoma.app/llms/architecture/execution-agent.txt): Deep dive into the core test execution engine - a platform-agnostic AI agent that powers web and mobile test execution through natural language.
- [AI Package](https://docs.autonoma.app/llms/architecture/ai-package.txt): Deep dive into the AI primitives that power test execution - model registry, visual checkers, point detection, object detection, and structured output generation.
- [Billing](https://docs.autonoma.app/llms/architecture/billing.txt): How Autonoma bills - the shared credit ledger, the five ways credits are consumed, the four ways they are granted, and the two settlement rails (Stripe and Vercel Marketplace) that sit on top of them.

## Documentation Sets

- [Complete documentation](https://docs.autonoma.app/llms-full.txt): all pages concatenated into a single file