Skip to content

Commit d479415

Browse files
committed
docs(wokwi-ci): explain simulation time limits
1 parent d079c84 commit d479415

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed

docs/wokwi-ci/getting-started.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,34 @@ For basic testing scenarios, you can use the [Wokwi CLI](./cli-installation) to
1515

1616
For more advanced testing scenarios, you can write [automation scenarios](./automation-scenarios) that automate the simulation, push buttons, change the state of the sensors, and check the serial output.
1717

18-
:::warning
19-
Wokwi CI is free while in beta. After the beta, we will charge based on the number of minutes your tests run on Wokwi CI. We plan to offer a free tier with a limited number of minutes per month.
20-
:::
21-
2218
## CI Architecture
2319

2420
Wokwi CI is powered a simulation server that runs in the cloud. The server receives your firmware binary, simulates it, and streams the serial output back to your CI system. The server is stateless and can run multiple simulations in parallel.
2521

2622
Wokwi does not store your firmware, and it is deleted from the cloud server after the simulation is finished. If you do not want to upload your firmware to the cloud, please contact us to discuss options for on-premise deployment of Wokwi CI.
2723

24+
## Simulation Time and Limits
25+
26+
The simulation time is calculated as the sum of the simulation time of all the tests in your CI workflow.
27+
28+
Each user has a limit of simulation time per month, according to their Wokwi plan:
29+
30+
- Free users: 50 minutes
31+
- Hobby and Hobby+ users: 200 minutes
32+
- Pro users: 2000 minutes
33+
34+
For more information about the paid plans, please see the [Pricing page](https://wokwi.com/pricing).
35+
36+
If you need more simulation time, please contact us to discuss options for a custom plan.
37+
38+
### Limiting Individual Test Time
39+
40+
You can limit the simulation time for each test in your CI workflow using the `--timeout` option of the [CLI](./cli-usage). For example, to limit the simulation time to 10 seconds, use:
41+
42+
```bash
43+
wokwi-cli --timeout 10000
44+
```
45+
2846
## Next Steps
2947

3048
- [Install the Wokwi CLI](./cli-installation) to run your firmware on your local machine or CI system.

0 commit comments

Comments
 (0)