Skip to content

Implement Mycel

Documentation in progress

This section is in active building and is not complete at the moment.

This section describes how to integrate Mycel into existing tools and applications such as PKM tools, text editors, services, ... (even video games, where utility meets enjoyment!).

Rather than a linear guide, this document outlines essential concepts and implementation details, as much of it is optional or customizable depending on what your environment needs and supports.

Sections or endpoints marked Required are strictly necessary for your client to function. The rest isn't required to get started, but skipping it can lead to bugs or a degraded experience — it's simply not blocking.

API instability

The Mycel API is not stable at the moment and can evolve quickly, introducing breaking changes.

Check the Awesome Mycel repository to see if an implementation already exists in your language of choice. It's a great source of inspiration or a place to reuse code from.