https://github.com/wokwi/wokwi-cli
Wokwi Command Line Interface (for CI use cases)
https://github.com/wokwi/wokwi-cli
Last synced: 2 months ago
JSON representation
Wokwi Command Line Interface (for CI use cases)
- Host: GitHub
- URL: https://github.com/wokwi/wokwi-cli
- Owner: wokwi
- License: mit
- Created: 2023-04-30T12:13:47.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-17T10:11:32.000Z (4 months ago)
- Last Synced: 2025-03-27T22:01:53.706Z (3 months ago)
- Language: TypeScript
- Size: 957 KB
- Stars: 25
- Watchers: 4
- Forks: 6
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# wokwi-cli
Wokwi Simulation API command line interface.
## Installation
Download the latest release from the [GitHub Releases page](https://github.com/wokwi/wokwi-cli/releases/latest). Rename the file to `wokwi-cli` (or `wokwi-cli.exe` on Windows), and put it in your `PATH`.
On Linux and macOS, you can also install the CLI using the following command:
```bash
curl -L https://wokwi.com/ci/install.sh | sh
```
And on Windows:
```powershell
iwr https://wokwi.com/ci/install.ps1 -useb | iex
```
## Usage
First, ensure that you set the `WOKWI_CLI_TOKEN` environment variable to your Wokwi API token. You can get your token from your [Wokwi CI Dashboard](https://wokwi.com/dashboard/ci).
```
wokwi-cli [directory]
```
The given directory should have a `wokwi.toml` file, as explained in [the documentation](https://docs.wokwi.com/vscode/project-config#wokwitoml).
For example, you could clone the [ESP32 Hello World binaries repo](https://github.com/wokwi/esp-idf-hello-world), and point the CLI at the `esp-idf-hello-world` directory:
```bash
git clone https://github.com/wokwi/esp-idf-hello-world
cd esp-idf-hello-world
wokwi-cli .
```
## Configuration Wizard
To generate a `wokwi.toml` and a default `diagram.json` files for your project, run:
```bash
wokwi-cli init
```
This will ask you a few questions and will create the necessary files in the current directory. If you want to create the files in a different directory, pass the directory name as an argument:
```bash
wokwi-cli init my-project
```
## Development
Clone the repository, install the npm depenedencies, and then run the CLI:
```bash
git clone https://github.com/wokwi/wokwi-cli
cd wokwi-cli
npm install
npm start
```
To pass command line arguments to the cli, use `npm start -- [arguments]`. For example, to see the help screen, run:
```
npm start -- -h
```
## License
[The MIT License (MIT)](LICENSE)