Skip to content

Usage

The Usage section of the Optics Framework documentation provides detailed guidance on how to interact with and leverage the framework effectively. Whether you're setting up test automation, executing test cases, or integrating keywords into your workflows, this section covers the essential tools and processes you need to get started and succeed.

Below are the primary usage guides, each tailored to a specific aspect of the framework:

  • CLI Usage Learn how to use the Optics Framework's command-line interface (CLI) to set up the environment, execute test cases, initialize projects, and manage configurations.

  • Library Usage Learn how to use the Optics Framework as a Python library for programmatic test automation, including configuration, element interactions, and session management.

  • Robot Usage Discover how to use the Optics Framework with Robot Framework, including library import, keyword usage, and test organization patterns.

  • Keyword Usage Explore the available keywords for defining test steps in test modules, including actions, verifications, and flow control operations, with detailed parameter explanations.

  • REST API Usage Learn how to use the Optics Framework's REST API for programmatic interaction, including session management, keyword execution, and real-time workspace monitoring.