Skip to main content

Getting Started

As a Guest of the Host App to which you have been invited, you now have the ability to push plug-ins into the application. Follow the rest of this guide to get going.

You'll need to install the xtp CLI, which will enable you to authenticate and push plug-ins into the Host Apps you have access to:

curl https://static.dylibso.com/cli/install.sh -s | bash

Here are a couple things you should know before writing and pushing plug-in code:

  1. Your plug-in code is compiled to WebAssembly (Wasm) before it is uploaded to XTP and run inside a Host App. This provides the optimal combination of security and performance. However, the trade-off is that some code might not compile... so, don't expect to open a TCP connection or make arbitrary system calls. Wasm is very capable, but limitations are necessary to keep systems secure.

  2. When crafting a plug-in, it must adhere to the Host App's schema, which defines the functions that you should implement in order to run at an Extension Point. You'll get helpful validation errors if your code doesn't comply with this schema, and you can always check out the full schema inside the XTP Dashboard, by viewing the Host App's Extension Point you are implementing.

  3. Help is just a Discord message away. Please, join the Extism Discord server and chat with us in the #xtp channel. Or, email us at support@dylibso.com - we're happy to help any way we can.

It's also important to note that as an XTP Guest, you are building plug-ins in WebAssembly by leveraging the Extism framework. Extism supports several languages for plug-in development through various Plug-in Development Kits (PDKs). Please familiarize yourself with the documentation.