Plugin Developer Guide

This guide walks you through creating a PRX plugin from scratch. By the end, you will have a working tool plugin that can be loaded into PRX.

Prerequisites

bash

# Install the WASM target
rustup target add wasm32-wasi

# Create a new plugin project
cargo new --lib my-plugin
cd my-plugin

Add the PRX PDK to your Cargo.toml:

toml

[dependencies]
prx-pdk = "0.1"

[lib]
crate-type = ["cdylib"]

A minimal tool plugin implements the Tool trait:

rust

use prx_pdk::prelude::*;

#[prx_tool]
fn hello(name: String) -> Result<String, PluginError> {
    Ok(format!("Hello, {}!", name))
}

bash

cargo build --target wasm32-wasi --release

The compiled plugin will be at target/wasm32-wasi/release/my_plugin.wasm.

bash

prx plugin install ./target/wasm32-wasi/release/my_plugin.wasm
prx plugin test my-plugin

Plugins can be shared as .wasm files or published to a plugin registry (coming soon).