Getting Started with RF Logs

RF Logs simplifies the process of managing and analyzing your Robot Framework test results. Follow these steps to easily upload, store, share and access your test logs from anywhere.

Step-by-Step Guide

1. Install RF Logs CLI

First, install the RF Logs client on your local machine or CI/CD environment. This tool will allow you to interact with the RF Logs service.

pip install rflogs

If you prefer to keep it isolated from your other Python packages, you can use pipx:

pipx install rflogs

2. Create a Project and Get Your API Key

Sign up and create a new project in RF Logs and select who to share it with. You'll receive an API key, which is your secure identifier for uploading logs to your project.

Set up your API key as an environment variable to keep it secure and easily accessible for the RF Logs client:

export RFLOGS_API_KEY=your_api_key_here

On Windows, use:

set RFLOGS_API_KEY=your_api_key_here

3. Run Your Tests and Upload Results

After running your Robot Framework tests, use the RF Logs client to upload your results. This command will automatically find and upload your latest test output:

rflogs upload

By uploading your results, you're making them accessible to the people you have chosen and analyzable through the RF Logs web interface.