Skip to content

Runners ​

Runners are the machines connected to Frametap.

They are installed and managed through the Frametap CLI, and they are what actually execute jobs such as recordings, screenshots, and watch-folder uploads.

What a Runner Does ​

A runner:

  • connects a machine to Frametap
  • exposes available displays
  • executes jobs on that machine
  • uploads recordings, screenshots, and files back to Frametap

In the app, you can inspect runners here:

Runner Status ​

The main runner states you will see are:

  • offline
  • ready
  • working

How to Set Up a Runner ​

The normal flow is:

  1. Create a runner enrollment key in Settings → API Keys
  2. Install the Frametap CLI on the target machine
  3. Run frametap up --token ...
  4. Confirm the runner appears in Runners

For the full setup flow, use these pages:

Capabilities ​

Depending on its enrollment key, a runner can be allowed to:

  • capture recordings
  • capture screenshots
  • upload files from watch folders

Released under the MIT License.