> For the complete documentation index, see [llms.txt](https://docs.qyrus.com/device-farm/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.qyrus.com/device-farm/readme.md).

# Introduction

Welcome to Device Farm, your all-in-one platform for manual and automated testing on real devices. Device Farm provides developers with a powerful testing environment to ensure the quality and performance of their applications across a wide range of devices and configurations.

### **Key Features**

* **Access to Real Devices & Cloud Farm:** Device Farm offers a diverse catalog of real Android and iOS smartphones, tablets, as well as Cloud Devices (AWS Device Farm integration), allowing you to test applications across physical hardware and cloud instances.
* **Manual Testing with Modern Workspace:** Interactively test devices with real-time WebRTC streaming, mouse and touch gestures, hardware controls, and a split-pane layout for concurrent log and vitals analysis.
* **In-Session App Management:** Upload and install new applications (`.apk`, `.ipa`, `.apks`, `.aab`) on-the-fly directly inside an active testing session without disconnecting.
* **Automated Testing with Appium:** Automate your test suites using modern Appium (v1 & v2) across Java, Python, and JavaScript frameworks, complete with live execution preview and live Appium logs streaming.
* **Element Explorer & XPath Tester:** Inspect UI elements, view full XML DOM hierarchies, highlight components on an interactive canvas, and verify XPath expressions live.
* **Comprehensive Test Reports & Vitals:** Generate rich reports containing time-series device vitals (CPU, Memory, Network) with CSV/PNG export, device and Appium logs, full video recordings, and screenshots.
* **Enterprise Collaboration & Security:** Integrated Jira bug reporting (with sub-tasks and Xray test integration), secure Project and User API tokens, and custom network profiles.

> Experience Device Farm right away by visiting [**Device Farm**](https://www.qyrus.com/solutions/device-farm-testing/).

***

## **User Guide**

1. [**Getting Started**](/device-farm/getting-started.md#getting-started)
   * [Top Navigation Bar (Navbar)](/device-farm/getting-started.md#top-navigation-bar-navbar)
   * [Interactive Product Tour Guide](/device-farm/getting-started.md#interactive-product-tour-guide)
   * [Navigating the Dashboard & Dashboard Details](/device-farm/getting-started.md#navigating-the-dashboard--dashboard-details)
   * [Navigating to Projects](/device-farm/getting-started.md#navigating-to-projects)
   * [Navigating to History & Filter Details](/device-farm/getting-started.md#navigating-to-history-sessions-summary--filter-details)
   * [Accessing Real Devices](/device-farm/getting-started.md#accessing-real-devices)
   * [Accessing Real Browsers](/device-farm/getting-started.md#accessing-real-browsers)
   * [Supported Browsers and Devices](/device-farm/supported-browser-and-device.md#supported-devices-and-browsers-list)
2. [**Project Creation and Setup**](/device-farm/project-creation-and-setup.md#project-creation--setup)
   * [Creating a Project](/device-farm/project-creation-and-setup.md#creating-a-project)
   * [Searching & Managing Projects](/device-farm/project-creation-and-setup.md#searching--managing-projects)
   * [Inside Project (Tests, Devices, Apps, Reports, Integrations, Filters)](/device-farm/project-creation-and-setup.md#inside-project-project-workspace)
   * [Application Management (Upload & Multipart)](/device-farm/project-creation-and-setup.md#application-management)
   * [Authentication Management (Project & User API Tokens)](/device-farm/project-creation-and-setup.md#authentication-management)
   * [Integrations Management (Jira & Xray)](/device-farm/project-creation-and-setup.md#integrations-management)
   * [Network Profiles Management (Presets & Custom)](/device-farm/project-creation-and-setup.md#network-profiles-management)
   * [Remote Devices Management](/device-farm/project-creation-and-setup.md#remote-devices-management)
   * [Swagger Documentation](/device-farm/project-creation-and-setup.md#swagger-documentation)
3. [**Running Manual Tests**](/device-farm/manual.md#manual-testing)
   * [Creating a Manual Device Session](/device-farm/manual.md#creating-a-manual-session)
   * [New Split-Pane Workspace vs Classic View](/device-farm/manual.md#workspace-layout)
   * [Navigation & Control Bar Tools](/device-farm/manual.md#navigation-bar)
   * [In-Session App Installation](/device-farm/manual.md#in-session-app-installation)
   * [Send Keys and Keyboard Capture](/device-farm/manual.md#send-keys-and-keyboard-capture)
   * [Device Logs & Live Streaming](/device-farm/manual.md#device-logs)
   * [Network Shaping & Wi-Fi Simulation](/device-farm/manual.md#network-shaping)
   * [Creating a Manual Browser Session](/device-farm/manual.md#creating-a-manual-browser-session)
4. [**Running Automated Tests**](/device-farm/automation.md#running-automation-session)
   * [Setting Up Automated Tests](/device-farm/automation.md#setting-up-automated-tests)
   * [Configuring Test Parameters & JSON Capabilities](/device-farm/automation.md#configuring-test-parameters)
   * [Code Examples (Java, Python, JavaScript)](/device-farm/automation.md#code-examples)
   * [Cloud Device Farm (AWS) Automation](/device-farm/automation.md#cloud-device-farm-automation)
   * [Running and Managing Automated Tests](/device-farm/automation.md#running-and-managing-automated-tests)
5. [**Test Reports and Analysis**](/device-farm/test-reports-and-analysis.md#test-reports)
   * [Steps to View Reports](/device-farm/test-reports-and-analysis.md#steps-to-view-reports)
   * [Viewing Device Vitals (CPU, Memory, Network Graphs & CSV Export)](/device-farm/test-reports-and-analysis.md#viewing-device-vitals)
   * [Accessing Logs, Screenshots & Video](/device-farm/test-reports-and-analysis.md#accessing-logs-screenshots--video)
   * [Sharing Reports via Email](/device-farm/test-reports-and-analysis.md#steps-to-view-reports)
6. [**Collaboration and Sharing**](/device-farm/integrations.md)
   * [Integrations with Collaboration Tools (Jira & Xray)](/device-farm/integrations.md#integrations-with-collaboration-tools)
7. [**Troubleshooting and FAQs**](/device-farm/faq.md#frequently-asked-questions-faq)
   * [Frequently Asked Questions](/device-farm/faq.md#frequently-asked-questions-faq)
8. **Advanced Features**
   * [App Upload / Application Management](/device-farm/project-creation-and-setup.md#application-management)
   * [In-Session App Installer](/device-farm/manual.md#in-session-app-installation)
   * [File Upload to Remote Storage](/device-farm/file-upload.md#1-introduction)
   * [Biometrics Bypass](/device-farm/biometrics.md#1-introduction) (**BETA**)
   * [Element Explorer & XPath Tester](/device-farm/element-explorer.md#element-explorer-feature-for-appium-automation-testing)
   * [Network Shaping](/device-farm/manual.md#network-shaping)
   * [Interrupt Testing (Call & SMS)](/device-farm/interrupt.md#interrupts)
9. **API Documentation**
   * [Accessing Device Farm via APIs](/device-farm/project-creation-and-setup.md#swagger-documentation)
   * [API Authentication & Token Management](/device-farm/project-creation-and-setup.md#authentication-management)
10. **AI Session**
    * [Record for Automation](/device-farm/ai-session/record-for-automation.md)
    * [Run a Session Without an App](/device-farm/ai-session/run-a-session.md)
    * [Upload an App to a Session](/device-farm/ai-session/upload-an-app.md)
    * [Run a Web Session](/device-farm/ai-session/run-a-session-with-web.md)
    * [Understand Agent Execution](/device-farm/ai-session/understand-agent-execution.md)
    * [Save a Session as a Project Test](/device-farm/ai-session/save-a-session-as-a-project-test.md)
    * [View Session Reports](/device-farm/ai-session/view-session-reports.md)
    * [Re-run a Session and View Its Reports](/device-farm/ai-session/rerun-a-session.md)
    * [Configure Jira and TestRail](/device-farm/ai-session/configure-jira-and-testrail.md)
    * [Manage Projects and Tests](/device-farm/ai-session/manage-projects-and-tests.md)
    * [Analyze Session Activity](/device-farm/ai-session/analyze-session-activity.md)
    * [Qyrion CLI](/device-farm/ai-session/qyrion-cli.md)
11. **AI Session**
    * [Run a Session Without an App](/device-farm/ai-session/run-a-session.md)
    * [Upload an App to a Session](/device-farm/ai-session/upload-an-app.md)
    * [Run a Web Session](/device-farm/ai-session/run-a-session-with-web.md)
    * [Understand Agent Execution](/device-farm/ai-session/understand-agent-execution.md)
    * [Save a Session as a Project Test](/device-farm/ai-session/save-a-session-as-a-project-test.md)
    * [View Session Reports](/device-farm/ai-session/view-session-reports.md)
    * [Re-run a Session and View Its Reports](/device-farm/ai-session/rerun-a-session.md)
    * [Configure Jira and TestRail](/device-farm/ai-session/configure-jira-and-testrail.md)
    * [Manage Projects and Tests](/device-farm/ai-session/manage-projects-and-tests.md)
    * [Analyze Session Activity](/device-farm/ai-session/analyze-session-activity.md)
    * [Record for Automation](/device-farm/ai-session/record-for-automation.md)
    * [Qyrion CLI](/device-farm/ai-session/qyrion-cli.md)
    * [AI Session FAQs](/device-farm/ai-session/aisession-faqs.md)

### Intended Audience

Device Farm caters to a wide range of users, including:

* **Developers:** Test your applications on various devices and configurations to ensure they work flawlessly across the spectrum.
* **Quality Assurance Teams:** Conduct thorough testing to catch bugs, identify performance bottlenecks, and ensure a high-quality user experience.
* **Testers:** Simulate user interactions on real devices, ensuring your app's functionality and user interface are up to the mark.

Whether you're a solo developer, a part of a development team, or a dedicated tester, Device Farm is designed to streamline your testing processes and help you deliver robust applications to your users.