Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/wokwi/wokwi-docs/llms.txt

Use this file to discover all available pages before exploring further.

You can use Wokwi CI with GitHub Actions to run your tests on every commit. You need to have a workflow that builds your project’s firmware. Add the following step to your workflow: 
- name: Test with Wokwi
  uses: wokwi/wokwi-ci-action@v1
  with:
    token: ${{ secrets.WOKWI_CLI_TOKEN }}
    path: / # directory with wokwi.toml, relative to repo's root
    expect_text: 'Hello, world!' # optional
For a complete list of options, check out the action’s README.

​
CLI Tokens

1

Generate a Token

Create an API token on the Wokwi CI Dashboard.
2

Add to GitHub Secrets

Set up the WOKWI_CLI_TOKEN secret in your repository settings:
  1. Go to your repository settings
  2. Navigate to Secrets and variables → Actions
  3. Click New repository secret
  4. Name it WOKWI_CLI_TOKEN and paste your token

​
Examples

The following projects are set up to run on Wokwi CI. You can use them as a reference for your own projects. Check out the .github/workflows directory for the complete GitHub Action configuration in each example.

ESP32 WiFi + FreeRTOS

ESP32 project demonstrating WiFi and FreeRTOS tasks

STM32 Nucleo64 C031C6

STM32 project with STM32 HAL

Raspberry Pi Pico SDK

Includes an automation scenario that verifies the LED blinking pattern

PlatformIO Pushbutton Counter

Includes an automation scenario that pushes the button and checks the serial output

ESP32-C6 LP I2C

Includes an automation scenario that interacts with an I2C device

Embedded Wizard Breakout Game

Example of taking a screenshot of the simulated LCD display

​
Additional Resources

Using PlatformIO CI and Wokwi in GitHub Actions

Blog post by Leonid Meleshin

Build docs developers (and LLMs) love

Get started for freeTalk to us