{
  "doc": {
    "id": "ui-coverage/get-started/setup",
    "title": "Get Started | UI Coverage Documentation",
    "description": "Set up UI Coverage by recording a run. No setup or instrumentation is required.",
    "section": "ui-coverage",
    "source_path": "/llm/markdown/ui-coverage/get-started/setup.md",
    "version": "24a73f8a97175663aaffd3b016289fb2a523a4ea",
    "updated_at": "2026-05-14T20:17:33.301Z",
    "headings": [
      {
        "id": "ui-coverage/get-started/setup#get-started",
        "text": "Get Started",
        "level": 1
      },
      {
        "id": "ui-coverage/get-started/setup#1-request-a-trial",
        "text": "1. Request a trial",
        "level": 2
      },
      {
        "id": "ui-coverage/get-started/setup#2-record-a-run",
        "text": "2. Record a run",
        "level": 2
      },
      {
        "id": "ui-coverage/get-started/setup#3-view-your-ui-coverage-results",
        "text": "3. View your UI Coverage results",
        "level": 2
      },
      {
        "id": "ui-coverage/get-started/setup#4-customize-your-results",
        "text": "4. Customize your results",
        "level": 2
      }
    ]
  },
  "content": {
    "type": "root",
    "children": [
      {
        "type": "heading",
        "depth": 1,
        "children": [
          {
            "type": "text",
            "value": "Get Started"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "UI Coverage works instantly, with no setup or code instrumentation required. If you record test runs to the Cypress Cloud with Test Replay, you're ready to start using UI Coverage."
          }
        ]
      },
      {
        "type": "heading",
        "depth": 2,
        "children": [
          {
            "type": "text",
            "value": "1. Request a trial"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "Get started with a free trial of UI Coverage. You'll receive a personalized demo using your existing test data to see where testing gaps exist for all of your Cypress projects."
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "link",
            "title": null,
            "url": "https://www.cypress.io/ui-coverage?utm_medium=get-started-page&utm_source=docs.cypress.io&utm_content=Request%20trial",
            "children": [
              {
                "type": "text",
                "value": "Request trial ➜"
              }
            ]
          }
        ]
      },
      {
        "type": "heading",
        "depth": 2,
        "children": [
          {
            "type": "text",
            "value": "2. Record a run"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "UI Coverage generates reports using "
          },
          {
            "type": "link",
            "title": null,
            "url": "/llm/markdown/cloud/features/test-replay.md",
            "children": [
              {
                "type": "text",
                "value": "Test Replay"
              }
            ]
          },
          {
            "type": "text",
            "value": " data and requires Cypress v13+. No additional configuration or instrumentation is required to start using UI Coverage."
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "link",
            "title": null,
            "url": "/llm/markdown/cloud/get-started/setup.md",
            "children": [
              {
                "type": "text",
                "value": "Record a run"
              }
            ]
          },
          {
            "type": "text",
            "value": " to the Cypress Cloud with Test Replay to start using UI Coverage."
          }
        ]
      },
      {
        "type": "heading",
        "depth": 2,
        "children": [
          {
            "type": "text",
            "value": "3. View your UI Coverage results"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "After recording a test run, you can view your UI Coverage results in the Cypress Cloud via the UI Coverage tab."
          }
        ]
      },
      {
        "type": "heading",
        "depth": 2,
        "children": [
          {
            "type": "text",
            "value": "4. Customize your results"
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "UI Coverage provides flexible configuration options to customize your reports. You can configure:"
          }
        ]
      },
      {
        "type": "list",
        "ordered": false,
        "start": null,
        "spread": false,
        "children": [
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "link",
                    "title": null,
                    "url": "/llm/markdown/ui-coverage/configuration/views.md",
                    "children": [
                      {
                        "type": "text",
                        "value": "Views"
                      }
                    ]
                  },
                  {
                    "type": "text",
                    "value": ": specify URL patterns that represent related pages or states of your application"
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "link",
                    "title": null,
                    "url": "/llm/markdown/ui-coverage/configuration/viewfilters.md",
                    "children": [
                      {
                        "type": "text",
                        "value": "View filters"
                      }
                    ]
                  },
                  {
                    "type": "text",
                    "value": ": specify URL patterns for URLs that should be excluded from UI Coverage for visiting and linking purposes"
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "link",
                    "title": null,
                    "url": "/llm/markdown/ui-coverage/configuration/elementfilters.md",
                    "children": [
                      {
                        "type": "text",
                        "value": "Element filters"
                      }
                    ]
                  },
                  {
                    "type": "text",
                    "value": ": specify selectors for elements that should be excluded from UI Coverage"
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "link",
                    "title": null,
                    "url": "/llm/markdown/ui-coverage/configuration/elementgroups.md",
                    "children": [
                      {
                        "type": "text",
                        "value": "Element groups"
                      }
                    ]
                  },
                  {
                    "type": "text",
                    "value": ": groups elements that are related to one another"
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "link",
                    "title": null,
                    "url": "/llm/markdown/ui-coverage/configuration/elements.md",
                    "children": [
                      {
                        "type": "text",
                        "value": "Elements"
                      }
                    ]
                  },
                  {
                    "type": "text",
                    "value": ": specify selectors to uniquely identify elements"
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "link",
                    "title": null,
                    "url": "/llm/markdown/ui-coverage/configuration/significantattributes.md",
                    "children": [
                      {
                        "type": "text",
                        "value": "Significant Attributes"
                      }
                    ]
                  },
                  {
                    "type": "text",
                    "value": ": prioritize the identification and grouping of specific attributes"
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "link",
                    "title": null,
                    "url": "/llm/markdown/ui-coverage/configuration/attributefilters.md",
                    "children": [
                      {
                        "type": "text",
                        "value": "Attribute filters"
                      }
                    ]
                  },
                  {
                    "type": "text",
                    "value": ": specify patterns for attributes and their values that should not be used for identifying and grouping elements"
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "link",
                    "title": null,
                    "url": "/llm/markdown/ui-coverage/configuration/additionalinteractioncommands.md",
                    "children": [
                      {
                        "type": "text",
                        "value": "Additional Interaction Commands"
                      }
                    ]
                  },
                  {
                    "type": "text",
                    "value": ": Define custom interactions that will count towards coverage scores, beyond built-in Cypress interaction commands"
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "link",
                    "title": null,
                    "url": "/llm/markdown/ui-coverage/configuration/allowedinteractioncommands.md",
                    "children": [
                      {
                        "type": "text",
                        "value": "Allowed Interaction Commands"
                      }
                    ]
                  },
                  {
                    "type": "text",
                    "value": ": Control which kinds of interactions are allowed for certain elements to restrict or expand what counts as \"covered\" for that element"
                  }
                ]
              }
            ]
          },
          {
            "type": "listItem",
            "spread": false,
            "checked": null,
            "children": [
              {
                "type": "paragraph",
                "children": [
                  {
                    "type": "link",
                    "title": null,
                    "url": "/llm/markdown/ui-coverage/configuration/profiles.md",
                    "children": [
                      {
                        "type": "text",
                        "value": "Profiles"
                      }
                    ]
                  },
                  {
                    "type": "text",
                    "value": ": use different configuration settings for different runs based on run tags"
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "value": "To add or modify the configuration for your project, navigate to the App Quality tab in your project settings."
          }
        ]
      }
    ]
  },
  "token_estimate": 447
}