Website   •   Dashboard   •   Docs   •   Roadmap   •   Branding   •   Discord

---

🔰 StarterKit Plugin

This is the starter kit for the Caido plugin system.

This template is full-stack, with both a backend and frontend plugin. This is called a plugin package. For frontend only use the frontend starterkit.

Note

I modified the starerkit to include React & MUI v6. I also included caido-material-ui to provide a consistent theme across your plugin and Caido.

I recommend using allotment for splitting your UI into multiple panels.

🏎️ Usage

1. pnpm install
2. Make some modifications in src
3. pnpm build
4. Upload the plugin_package.zip in the dist folder to your Caido instance

🗒️ Release

The Github Action release can be used to create a release of your plugin package.

If you want to sign your plugin package, you need an ed25519 private key named PRIVATE_KEY in your Github Action secrets.

To release your plugin to the store, you have to follow a set of operations. Please check out our documentation on the subject.