Skip to content

Latest commit

 

History

History
151 lines (99 loc) · 4.97 KB

README.md

File metadata and controls

151 lines (99 loc) · 4.97 KB
Raw

JetBrains Plugin Version Contributors MIT License Issues Forks Stargazers


Wokwi Intellij Icon

Wokwi Intellij Plugin

Integrate Wokwi in Intellij-based Jetbrains IDEs.
Explore the docs »

Install in IDE · Report Bug · Request Feature

About The Plugin

Wokwi Debug Showcase

The Wokwi Intellij plugin integrates the Wokwi simulator with Jetbrains IDEs like CLion and RustRover. It adopts the configuration approach of the Wokwi VS code extension for seamless IDE transitions and supports the same platforms.

This plugin is a community plugin and not maintained by the Wokwi team.

Detailed information on using the plugin can be found in the documentation.

Features

  • Run simulation in IDE window
  • Automatically restart the simulation on rebuild
  • Intelligent configuration checking
  • Intellij idiomatic debugging (CLion only)

Documentation

Please visit the Wokwi Intellij documentation.

Installation

To follow the installation instructions, users typically navigate to the installation section.

For building and installing the plugin from source:

  1. Clone or download the repository.
  2. Execute ./gradlew buildPlugin.
    This action saves the plugin build as build/distributions/wokwi-intellij-x.x.x.zip.
  3. Follow steps to install the plugin from disk.

Roadmap

  • Make Console writable
  • Add Serial Port forwarding
  • Add IoT gateway
  • Support custom chips
  • Add diagram.json editor

See the open issues for a full list of proposed features (and known issues).

Contributing

To make this plugin even better, contributions are very welcome!

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag enhancement.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.