Skip to content

waveSDK Logo

waveSDK

Show/hide badges GitHub License
GitHub Actions Test Status GitHub Actions Release Status GitHub Actions Documentation Status
Sonar Quality Gate Sonar Coverage
See more badges Sonar Quality Gate (dev branch) Sonar Coverage (dev branch) GitHub commits since latest release (branch)

Contents

Where's the "How to use" section?

This file does not attempt to be a full documentation on how to use waveSDK. Instead, you can find full documentation here.
That being said, the sections under "Use cases" might help with getting started quickly with waveSDK.

How can I see what is being worked on at The waveIDE Project?

You can find the official bug tracker and roadmap here.

What is waveSDK?

waveIDE's libre plugin SDK.

waveSDK is the extensibility SDK that powers waveIDE's plugin system.

Despite being made for waveIDE, it is actually fully decoupled and can be used in any code editor. In fact, there's specific guidance for how to do so.

However, our documentation is targetted mostly at plugin authors writing extensions for waveIDE, as that's the most common use case of waveSDK.

Installation & Use cases

In this section, you'll find information on how to install and use waveSDK in your project, whether it is a plugin for waveIDE, your own code editor or a plugin for an editor that isn't waveIDE, but supports waveSDK nonetheless.

Note

Always refer to the documentation of each code editor when writing plugins. Just because the API you use via waveSDK is the same for every editor, it doesn't mean every editor handles it the same (some editors might intentionally skip implementing certain operations, for instance).

Writing a plugin for waveIDE

TODO.

Common patterns

TODO - talk about usual patterns such as adding language support, etc

Implementing waveSDK in your own code editor

TODO.

Writing a plugin for a non-waveIDE code editor that supports waveSDK

TODO.


waveSDK is part of The waveIDE Project, an Ocean Apocalypse project.
It is licensed under Apache License, Version 2.0.

waveSDK Β© 2026 by Ocean Apocalypse is licensed under Apache License, Version 2.0

Releases

Sponsor this project

Packages

Used by

Contributors

Languages