Robot Framework documentation

This page contains links to version specific Robot Framework User Guide, standard library, and built-in tool documentation. See http://robotframework.org and GitHub project pages for more information about the framework and the rich ecosystem around it in general.

User Guide

Robot Framework User Guide is a reference manual explaining all Robot Framework features in detail. You can either View the selected version online or Download it as a zip package. This package contains also standard library documentation under libraries directory.

Standard libraries

These test libraries are distributed with Robot Framework. Click View to view the selected version online, and use Ctrl-S or equivalent to save the opened page locally if needed

New standard libraries are added time to time. Dropdown menus list versions in which libraries are available.

Library	Documentation	Introduction
BuiltIn	Latest 7.3.2 7.3.1 7.3 7.2.2 7.2.1 7.2 7.1.1 7.1 7.0.1 7.0 6.1.1 6.1 6.0.2 6.0.1 6.0 5.0 4.1.3 4.1.2 4.1.1 4.1 4.0.3 4.0.2 4.0.1 4.0 3.2.2 3.2.1 3.2 3.1.2 3.1.1 3.1 3.0.4 3.0.3 3.0.2 3.0.1 3.0 2.9.2 2.9.1 2.9 2.8.7 2.8.6 2.8.5 2.8.4 2.8.3 2.8.2 2.8.1 2.8 2.7.7 2.7.6 2.7.5 2.7.4 2.7.3 2.7.2 2.7.1 2.7 2.6.3 2.6.2 2.6.1 2.6 2.5.7 2.5.6 2.5.5 2.5.4 2.5.3 2.5.2 2.5.1 2.5 2.1.3 2.1.2 2.1.1 2.1 2.0.4 2.0.3 2.0.2 2.0.1 2.0 View	Contains generic often needed keywords. Imported automatically and thus always available.
Collections	Latest 7.3.2 7.3.1 7.3 7.2.2 7.2.1 7.2 7.1.1 7.1 7.0.1 7.0 6.1.1 6.1 6.0.2 6.0.1 6.0 5.0 4.1.3 4.1.2 4.1.1 4.1 4.0.3 4.0.2 4.0.1 4.0 3.2.2 3.2.1 3.2 3.1.2 3.1.1 3.1 3.0.4 3.0.3 3.0.2 3.0.1 3.0 2.9.2 2.9.1 2.9 2.8.7 2.8.6 2.8.5 2.8.4 2.8.3 2.8.2 2.8.1 2.8 2.7.7 2.7.6 2.7.5 2.7.4 2.7.3 2.7.2 2.7.1 2.7 2.6.3 2.6.2 2.6.1 2.6 2.5.7 2.5.6 2.5.5 2.5.4 2.5.3 2.5.2 2.5.1 2.5 2.1.3 2.1.2 2.1.1 2.1 2.0.4 2.0.3 2.0.2 2.0.1 2.0 View	Contains keywords for handling lists and dictionaries.
DateTime	Latest 7.3.2 7.3.1 7.3 7.2.2 7.2.1 7.2 7.1.1 7.1 7.0.1 7.0 6.1.1 6.1 6.0.2 6.0.1 6.0 5.0 4.1.3 4.1.2 4.1.1 4.1 4.0.3 4.0.2 4.0.1 4.0 3.2.2 3.2.1 3.2 3.1.2 3.1.1 3.1 3.0.4 3.0.3 3.0.2 3.0.1 3.0 2.9.2 2.9.1 2.9 2.8.7 2.8.6 2.8.5 View	Supports creating and verifying date and time values as well as calculations between them.
Dialogs	Latest 7.3.2 7.3.1 7.3 7.2.2 7.2.1 7.2 7.1.1 7.1 7.0.1 7.0 6.1.1 6.1 6.0.2 6.0.1 6.0 5.0 4.1.3 4.1.2 4.1.1 4.1 4.0.3 4.0.2 4.0.1 4.0 3.2.2 3.2.1 3.2 3.1.2 3.1.1 3.1 3.0.4 3.0.3 3.0.2 3.0.1 3.0 2.9.2 2.9.1 2.9 2.8.7 2.8.6 2.8.5 2.8.4 2.8.3 2.8.2 2.8.1 2.8 2.7.7 2.7.6 2.7.5 2.7.4 2.7.3 2.7.2 2.7.1 2.7 2.6.3 2.6.2 2.6.1 2.6 2.5.7 2.5.6 2.5.5 2.5.4 2.5.3 2.5.2 2.5.1 2.5 2.1.3 2.1.2 2.1.1 2.1 View	Supports pausing the test execution and getting input from users.
OperatingSystem	Latest 7.3.2 7.3.1 7.3 7.2.2 7.2.1 7.2 7.1.1 7.1 7.0.1 7.0 6.1.1 6.1 6.0.2 6.0.1 6.0 5.0 4.1.3 4.1.2 4.1.1 4.1 4.0.3 4.0.2 4.0.1 4.0 3.2.2 3.2.1 3.2 3.1.2 3.1.1 3.1 3.0.4 3.0.3 3.0.2 3.0.1 3.0 2.9.2 2.9.1 2.9 2.8.7 2.8.6 2.8.5 2.8.4 2.8.3 2.8.2 2.8.1 2.8 2.7.7 2.7.6 2.7.5 2.7.4 2.7.3 2.7.2 2.7.1 2.7 2.6.3 2.6.2 2.6.1 2.6 2.5.7 2.5.6 2.5.5 2.5.4 2.5.3 2.5.2 2.5.1 2.5 2.1.3 2.1.2 2.1.1 2.1 2.0.4 2.0.3 2.0.2 2.0.1 2.0 View	Enables performing various operating system related tasks.
Process	Latest 7.3.2 7.3.1 7.3 7.2.2 7.2.1 7.2 7.1.1 7.1 7.0.1 7.0 6.1.1 6.1 6.0.2 6.0.1 6.0 5.0 4.1.3 4.1.2 4.1.1 4.1 4.0.3 4.0.2 4.0.1 4.0 3.2.2 3.2.1 3.2 3.1.2 3.1.1 3.1 3.0.4 3.0.3 3.0.2 3.0.1 3.0 2.9.2 2.9.1 2.9 2.8.7 2.8.6 2.8.5 2.8.4 2.8.3 2.8.2 2.8.1 2.8 View	Supports executing processes in the system.
Remote	N/A	Part of the remote library interface. Does not have any keywords of its own.
Screenshot	Latest 7.3.2 7.3.1 7.3 7.2.2 7.2.1 7.2 7.1.1 7.1 7.0.1 7.0 6.1.1 6.1 6.0.2 6.0.1 6.0 5.0 4.1.3 4.1.2 4.1.1 4.1 4.0.3 4.0.2 4.0.1 4.0 3.2.2 3.2.1 3.2 3.1.2 3.1.1 3.1 3.0.4 3.0.3 3.0.2 3.0.1 3.0 2.9.2 2.9.1 2.9 2.8.7 2.8.6 2.8.5 2.8.4 2.8.3 2.8.2 2.8.1 2.8 2.7.7 2.7.6 2.7.5 2.7.4 2.7.3 2.7.2 2.7.1 2.7 2.6.3 2.6.2 2.6.1 2.6 2.5.7 2.5.6 2.5.5 2.5.4 2.5.3 2.5.2 2.5.1 2.5 2.1.3 2.1.2 2.1.1 2.1 2.0.4 2.0.3 2.0.2 2.0.1 2.0 View	Provides keywords to capture and store screenshots of the desktop.
String	Latest 7.3.2 7.3.1 7.3 7.2.2 7.2.1 7.2 7.1.1 7.1 7.0.1 7.0 6.1.1 6.1 6.0.2 6.0.1 6.0 5.0 4.1.3 4.1.2 4.1.1 4.1 4.0.3 4.0.2 4.0.1 4.0 3.2.2 3.2.1 3.2 3.1.2 3.1.1 3.1 3.0.4 3.0.3 3.0.2 3.0.1 3.0 2.9.2 2.9.1 2.9 2.8.7 2.8.6 2.8.5 2.8.4 2.8.3 2.8.2 2.8.1 2.8 2.7.7 2.7.6 2.7.5 2.7.4 2.7.3 2.7.2 2.7.1 2.7 2.6.3 2.6.2 2.6.1 2.6 2.5.7 2.5.6 2.5.5 2.5.4 2.5.3 2.5.2 2.5.1 2.5 2.1.3 2.1.2 2.1.1 2.1 View	Library for manipulating strings and verifying their contents.
Telnet	Latest 7.3.2 7.3.1 7.3 7.2.2 7.2.1 7.2 7.1.1 7.1 7.0.1 7.0 6.1.1 6.1 6.0.2 6.0.1 6.0 5.0 4.1.3 4.1.2 4.1.1 4.1 4.0.3 4.0.2 4.0.1 4.0 3.2.2 3.2.1 3.2 3.1.2 3.1.1 3.1 3.0.4 3.0.3 3.0.2 3.0.1 3.0 2.9.2 2.9.1 2.9 2.8.7 2.8.6 2.8.5 2.8.4 2.8.3 2.8.2 2.8.1 2.8 2.7.7 2.7.6 2.7.5 2.7.4 2.7.3 2.7.2 2.7.1 2.7 2.6.3 2.6.2 2.6.1 2.6 2.5.7 2.5.6 2.5.5 2.5.4 2.5.3 2.5.2 2.5.1 2.5 2.1.3 2.1.2 2.1.1 2.1 2.0.4 2.0.3 2.0.2 2.0.1 2.0 View	Supports connecting to Telnet servers and executing commands on the opened connections.
XML	Latest 7.3.2 7.3.1 7.3 7.2.2 7.2.1 7.2 7.1.1 7.1 7.0.1 7.0 6.1.1 6.1 6.0.2 6.0.1 6.0 5.0 4.1.3 4.1.2 4.1.1 4.1 4.0.3 4.0.2 4.0.1 4.0 3.2.2 3.2.1 3.2 3.1.2 3.1.1 3.1 3.0.4 3.0.3 3.0.2 3.0.1 3.0 2.9.2 2.9.1 2.9 2.8.7 2.8.6 2.8.5 2.8.4 2.8.3 2.8.2 2.8.1 2.8 View	Library for verifying and modifying XML documents.

Built-in tools

In addition to the core test execution engine, there are some supporting tools built-in to Robot Framework. Clicking View opens the documentation of the selected tool online. In practice the documentation is opened from the selected User Guide version.

Dropdown menus list versions in which tools are available.

Tool	Documentation	Introduction
Rebot	Latest 7.3.2 7.3.1 7.3 7.2.2 7.2.1 7.2 7.1.1 7.1 7.0.1 7.0 6.1.1 6.1 6.0.2 6.0.1 6.0 5.0 4.1.3 4.1.2 4.1.1 4.1 4.0.3 4.0.2 4.0.1 4.0 3.2.2 3.2.1 3.2 3.1.2 3.1.1 3.1 3.0.4 3.0.3 3.0.2 3.0.1 3.0 2.9.2 2.9.1 2.9 2.8.7 2.8.6 2.8.5 2.8.4 2.8.3 2.8.2 2.8.1 2.8 2.7.7 2.7.6 2.7.5 2.7.4 2.7.3 2.7.2 2.7.1 2.7 2.6.3 2.6.2 2.6.1 2.6 2.5.7 2.5.6 2.5.5 2.5.4 2.5.3 2.5.2 2.5.1 2.5 2.1.3 2.1.2 2.1.1 2.1 2.0.4 2.0.3 2.0.2 2.0.1 2.0 View	Tool for generating logs and reports based on XML outputs and for combining multiple outputs together.
Libdoc	Latest 7.3.2 7.3.1 7.3 7.2.2 7.2.1 7.2 7.1.1 7.1 7.0.1 7.0 6.1.1 6.1 6.0.2 6.0.1 6.0 5.0 4.1.3 4.1.2 4.1.1 4.1 4.0.3 4.0.2 4.0.1 4.0 3.2.2 3.2.1 3.2 3.1.2 3.1.1 3.1 3.0.4 3.0.3 3.0.2 3.0.1 3.0 2.9.2 2.9.1 2.9 2.8.7 2.8.6 2.8.5 2.8.4 2.8.3 2.8.2 2.8.1 2.8 2.7.7 2.7.6 2.7.5 2.7.4 2.7.3 2.7.2 2.7.1 2.7 View	Tool for generating keyword documentation for test libraries and resource files.
Testdoc	Latest 7.3.2 7.3.1 7.3 7.2.2 7.2.1 7.2 7.1.1 7.1 7.0.1 7.0 6.1.1 6.1 6.0.2 6.0.1 6.0 5.0 4.1.3 4.1.2 4.1.1 4.1 4.0.3 4.0.2 4.0.1 4.0 3.2.2 3.2.1 3.2 3.1.2 3.1.1 3.1 3.0.4 3.0.3 3.0.2 3.0.1 3.0 2.9.2 2.9.1 2.9 2.8.7 2.8.6 2.8.5 2.8.4 2.8.3 2.8.2 2.8.1 2.8 2.7.7 2.7.6 2.7.5 2.7.4 2.7.3 2.7.2 2.7.1 2.7 View	Generates high level HTML documentation based on Robot Framework test cases.
Tidy	Latest 7.3.2 7.3.1 7.3 7.2.2 7.2.1 7.2 7.1.1 7.1 7.0.1 7.0 6.1.1 6.1 6.0.2 6.0.1 6.0 5.0 4.1.3 4.1.2 4.1.1 4.1 4.0.3 4.0.2 4.0.1 4.0 3.2.2 3.2.1 3.2 3.1.2 3.1.1 3.1 3.0.4 3.0.3 3.0.2 3.0.1 3.0 2.9.2 2.9.1 2.9 2.8.7 2.8.6 2.8.5 2.8.4 2.8.3 2.8.2 2.8.1 2.8 2.7.7 2.7.6 2.7.5 2.7.4 2.7.3 2.7.2 2.7.1 2.7 View	Tool for cleaning up and changing format of Robot Framework test data files.