Skip to main content
The CLI allows you to run Wokwi simulations from your terminal, and integrate them with your CI system. We recommend using the Wokwi for VS Code extension for local development, and the CLI for running your tests on CI. Both the CLI and the VS Code extension use the same project configuration files (wokwi.toml and diagram.json), so you can use the VS Code extension to create and test your project, and then use the CLI to run it on CI.

Installation

To install the Wokwi CLI on Linux or macOS, run the following command:
curl -L https://wokwi.com/ci/install.sh | sh

ESP-IDF Extension

If your project is using the ESP-IDF toolchain, you can install an extension for ESP-IDF which will allow you to access it from idf.py. To install it, simply run the following command:
pip install idf-wokwi
Read more about idf-wokwi on our ESP-IDF simulation extension page.

Build docs developers (and LLMs) love