# LitmusCheck documentation

## Docs

- [Welcome to LitmusCheck](https://documentation.litmuscheck.com/getting-started/welcome.md): LitmusCheck is now open source — self-host the stack and write AI-powered Playwright tests
- [Create your first test](https://documentation.litmuscheck.com/getting-started/onboard.md): Learn how to write a basic test
- [Suites](https://documentation.litmuscheck.com/core-concepts/suites.md): Organize related tests into suites and control execution
- [Tests](https://documentation.litmuscheck.com/core-concepts/tests.md): Learn how to write, structure, and execute tests in LitmusCheck
- [Segments](https://documentation.litmuscheck.com/core-concepts/segments.md): Group reusable steps and selectors to compose larger flows
- [Elements](https://documentation.litmuscheck.com/core-concepts/elements.md): Define page elements (selectors), and reuse best practices
- [Compose](https://documentation.litmuscheck.com/core-concepts/compose.md): Compose a new test in english with live visual execution
- [Variables](https://documentation.litmuscheck.com/core-concepts/variables.md): Use variables in environment, data files or in-test state
- [Data-Driven Testing](https://documentation.litmuscheck.com/core-concepts/data-driven-testing.md): Run tests with datasets (CSV) using parameterization
- [Planning Agent](https://documentation.litmuscheck.com/agents/planning.md): Plans test goals, segments, and execution strategy
- [Goal-to-Test Agent](https://documentation.litmuscheck.com/agents/goal-to-test.md): Converts high-level goals into executable test steps
- [Prompt to Page Element](https://documentation.litmuscheck.com/agents/locator-generation.md): Generates robust selectors for Elements (POM) from natural language prompt
- [Custom Script Gen Agent](https://documentation.litmuscheck.com/agents/custom-script-generation.md): Creates tailored scripts and utilities for complex flows
- [Failure Triaging Agent](https://documentation.litmuscheck.com/agents/triage-failure.md): Diagnoses failures with logs, traces, and probable causes
- [Test Healing Agent](https://documentation.litmuscheck.com/agents/heal-test.md): Automatically heals flaky tests by updating steps/selectors
- [Compose a Test](https://documentation.litmuscheck.com/composing/overview.md): Create a new test in English with side-by-side live execution
- [AI Steps](https://documentation.litmuscheck.com/composing/ai-steps.md): Use AI-driven actions to perform complex interactions
- [Non‑AI Steps](https://documentation.litmuscheck.com/composing/non-ai-steps.md): Define deterministic steps like go-to, wait, reload
- [From Goal to Test](https://documentation.litmuscheck.com/composing/goal.md): Turn a natural-language goal into an executable test, or part of a test
- [When to Use AI ](https://documentation.litmuscheck.com/composing/ai-use.md): Choose between using AI to generate a script or to execute a step at run time
- [Using Elements](https://documentation.litmuscheck.com/composing/using-elements.md): Save, manage, and reuse elements to create stable, maintainable tests
- [Using Segments](https://documentation.litmuscheck.com/composing/using-segments.md): Compose flows by reusing grouped steps and actions
- [AI Script](https://documentation.litmuscheck.com/composing/ai-script-generation.md): Execute complex or custom actions using a plain-English prompt
- [Run Script](https://documentation.litmuscheck.com/composing/manual-script-generation.md): Execute custom Playwright code snippets within your test
- [Data‑Driven Tests](https://documentation.litmuscheck.com/composing/data-driven-tests.md): Iterate test steps over datasets with parameters
- [Running Overview](https://documentation.litmuscheck.com/running/overview.md): Overview of executing tests and managing runs in LitmusCheck
- [Run a Suite from the Dashboard and Suite Page](https://documentation.litmuscheck.com/running/dashboard.md): A step-by-step guide to running test suites in LitmusCheck from the dashboard and suite page
- [Schedules](https://documentation.litmuscheck.com/running/schedules.md): Create, manage, and automate recurring test runs
- [CI/CD Integration](https://documentation.litmuscheck.com/running/cicd.md): Trigger tests from pipelines and PRs with GitHub Actions
- [Run a test](https://documentation.litmuscheck.com/running/test.md): A guide to executing individual tests in LitmusCheck
- [Reports](https://documentation.litmuscheck.com/running/reports.md): View execution reports, failures, and performance insights
- [Logs & Traces](https://documentation.litmuscheck.com/running/logs-and-traces.md): Inspect run logs, traces, and artifacts for troubleshooting
- [Runtime Configuration](https://documentation.litmuscheck.com/running/config.md): Configure environments, secrets, and test runtime settings
- [Tags](https://documentation.litmuscheck.com/running/tags.md): Use tags to organize and run specific groups of tests.
- [AI-Triaging](https://documentation.litmuscheck.com/maintain/ai-triaging.md): How to use AI-Triage results to maintain your tests
- [Quarantine](https://documentation.litmuscheck.com/maintain/quarantine.md): Isolate flaky or failing tests to reduce failure 'noise'
- [Updating Locators](https://documentation.litmuscheck.com/maintain/updating-locators.md): Update selectors safely when the UI changes
- [Updating Segments](https://documentation.litmuscheck.com/maintain/updating-segments.md): Refactor and evolve segments without breaking tests
- [AI-Assisted Healing](https://documentation.litmuscheck.com/maintain/ai-assisted-healing.md): Use AI to suggest and apply fixes to failing tests

## OpenAPI Specs

- [openapi](https://documentation.litmuscheck.com/api-reference/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.