Libraries
Every library is available in every script, in the server, the CLI, FitNesse and TestNG. Search by library, object or function, or filter by category. Tables that functions return are described under Table shapes. Download the catalogue or the type stubs for your editor.
Browser
Start a browser with Selenium (Sel) or Playwright (Play); both give you the same Browser and Locator.
- Sel Browser automation with Selenium: starts Chrome (default) or Firefox and returns a Browser to drive it.
- Play Browser automation with Playwright: starts Chromium and returns a Browser to drive it.
- Browser An open browser window with its tabs, driven by Selenium (`Sel.start()`) or Playwright (`Play.start()`).
- Locator A handle on one element, or a group of elements, on the page, found by a selector.
APIs & Data
Call services and work with structured data.
- Rest HTTP client for REST and other web APIs.
- Soap Minimal SOAP 1.1 client: posts an XML envelope to an endpoint and gives back the response body as a string, plus an XPath helper to pick values out of it.
- Json Reads, encodes, decodes and converts JSON.
- Xml Reads, builds, transforms and writes XML documents.
- Yaml Reads, writes, encodes and decodes YAML.
- Sql Connects to relational databases over JDBC and runs SQL on them.
- Couch Talks to the CouchDB server that is configured in the project settings (URL, user name and password under Project settings > CouchDB in Reflex).
- Data Collects the result data of a run in one table.
Files & Documents
Read, write and convert files, spreadsheets and scanned documents.
- Fl Reads, writes, copies, moves, removes, inspects and searches files in the project workspace.
- Csv Reads delimited text files (CSV) into Lua tables.
- Xlsx Opens existing Excel `.xlsx` workbooks, reads and changes cells and saves the result.
- Ocr Reads text from images and PDF files with the Tesseract OCR engine (LSTM mode), for scanned documents and screenshots.
- Zip Creates and extracts `.zip` archives in the project workspace.
- Tar Creates and extracts `.tar` archives, optionally gzip-compressed, in the project workspace.
- SevenZip Extracts `.7z` archives.
Messaging & Integrations
Reach people and external platforms.
- Mail Sends email over SMTP and reads a mailbox over IMAP or POP3.
- Telegram Sends messages to a Telegram chat through a bot and waits for the answer, for notifications and simple human-in-the-loop approvals.
- Sharepoint Upload, download, list, move and delete files in SharePoint Online document libraries (Microsoft Graph).
- Dashboard Builds the dashboard of a run: headers, paragraphs, lists, tables, dividers and charts that the server shows on the dashboard tab of the run.
AI in scripts
Let a script hand a task to an AI coding CLI that is installed on the agent host.
- Codex Lets a script hand work to the OpenAI Codex CLI (`codex exec`): Codex.task runs one instruction, Codex.session keeps a conversation going over several messages.
- Copilot Lets a script hand work to the GitHub Copilot CLI (`copilot -p`): Copilot.task runs one instruction, Copilot.session keeps a conversation going over several messages.
- OpenCode Lets a script hand work to the OpenCode CLI (`opencode run`): OpenCode.task runs one instruction, OpenCode.session keeps a conversation going over several messages.
Remote & Infrastructure
Connect to servers and network shares.
Utilities
Small helpers every script ends up needing.
- Assert Checks conditions in a script and fails with a readable message when they do not hold.
- Concurrent Runs several Lua functions at the same time on worker threads and waits until all of them are done.
- Dates Formats, shifts and compares dates that are passed around as text.
- Random Generates random test data: whole numbers, letter strings and IBANs.
- Retry Runs a Lua function again when it fails, for steps that can fail temporarily (an API that is not ready yet, a file that has not arrived).
- String Regular expressions, text replacement, Base64 and XML formatting for strings.
- Timer A stopwatch for measuring how long steps of a script take.
No library matches your search. Try a function name such as sheet or click.