# Autonoma Docs

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

## Pages

- [Introduction](https://docs.agent.autonoma.app/llms/index.txt): Learn how to integrate Autonoma's agentic end-to-end testing platform into your application.
- [Step 1: Generate Knowledge Base](https://docs.agent.autonoma.app/llms/test-planner/step-1-knowledge-base.txt): Analyze your codebase to produce AUTONOMA.md and features.json. This is the first step of the pipeline and feeds every step that follows.
- [Step 2: Entity Creation Audit](https://docs.agent.autonoma.app/llms/test-planner/step-2-entity-audit.txt): Describe every way each database model is created so the Environment Factory can plan factories, scenario trees, and teardown correctly.
- [Step 3: Generate Scenarios](https://docs.agent.autonoma.app/llms/test-planner/step-3-scenarios.txt): Design the standard, empty, and large test data environments from the knowledge base and the entity audit.
- [Step 4: Implement Environment Factory](https://docs.agent.autonoma.app/llms/test-planner/step-4-implement.txt): Install the Autonoma SDK in your backend, configure the handler, and register a factory for every model with dedicated creation code. Validation of the full up/down lifecycle happens in Step 5.
- [Step 5: Validate Scenario Lifecycle](https://docs.agent.autonoma.app/llms/test-planner/step-5-validate.txt): Run discover/up/down against every scenario, fix whatever breaks, emit scenario recipes, and upload them to the dashboard.
- [Step 6: E2E Tests](https://docs.agent.autonoma.app/llms/test-planner/step-6-e2e-tests.txt): Generate an exhaustive E2E test suite as markdown files, ready to upload to Autonoma. Runs against scenario data that was validated end-to-end in Step 5.
- [Environment Factory Guide](https://docs.agent.autonoma.app/llms/guides/environment-factory.txt): How to set up the Autonoma Environment Factory in your application using the SDK — a single POST endpoint for creating and destroying isolated test environments.
- [Scenario Recipe Schema](https://docs.agent.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.
- [TypeScript](https://docs.agent.autonoma.app/llms/examples/typescript.txt): Autonoma Environment Factory examples with Express, Hono, and Next.js.
- [Python](https://docs.agent.autonoma.app/llms/examples/python.txt): Autonoma Environment Factory examples with FastAPI, Flask, and Django.
- [Elixir](https://docs.agent.autonoma.app/llms/examples/elixir.txt): Autonoma Environment Factory example with Phoenix.
- [Java](https://docs.agent.autonoma.app/llms/examples/java.txt): Autonoma Environment Factory example with Spring Boot.
- [Ruby](https://docs.agent.autonoma.app/llms/examples/ruby.txt): Autonoma Environment Factory example with Rails.
- [Rust](https://docs.agent.autonoma.app/llms/examples/rust.txt): Autonoma Environment Factory example with Axum.
- [Go](https://docs.agent.autonoma.app/llms/examples/go.txt): Autonoma Environment Factory example with Gin.
- [PHP](https://docs.agent.autonoma.app/llms/examples/php.txt): Autonoma Environment Factory example with Laravel.
- [Development Setup](https://docs.agent.autonoma.app/llms/development/setup.txt): How to get Autonoma AI running locally - from prerequisites through a working dev environment.
- [Architecture Overview](https://docs.agent.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.agent.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.agent.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.agent.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.agent.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.agent.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.agent.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.
- [Examples](https://docs.agent.autonoma.app/llms/examples.txt): Working examples of the Autonoma Environment Factory across 8 languages and 11 framework combinations.
- [Previewkit](https://docs.agent.autonoma.app/llms/previewkit.txt): Vercel-style preview environments for every pull request. Drop a .preview.yaml in your repo, open a PR, get a live URL.
- [.preview.yaml Reference](https://docs.agent.autonoma.app/llms/previewkit/preview-yaml.txt): Complete schema for the Previewkit configuration file - apps, services, recipes, environment templating, and post-deploy hooks.
- [Secrets](https://docs.agent.autonoma.app/llms/previewkit/secrets.txt): How to manage credentials, API keys, and other sensitive values for your Previewkit environments.
- [E2E Test Planner](https://docs.agent.autonoma.app/llms/test-planner.txt): A Claude Code plugin that analyzes your codebase and produces a complete E2E test suite, plus the infrastructure to run it.
- [Factory fidelity rubric](https://docs.agent.autonoma.app/llms/test-planner/factory-fidelity-rubric.txt): Semantic rubric used by the plugin to verify that each factory faithfully reproduces the side effects the Step 2 audit recorded.

## Documentation Sets

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