Github   •   Documentation   •   Discord

---

👨‍🏭 Dev

A development toolkit for building Caido plugins. This CLI tool simplifies the process of developing, building, and packaging Caido plugins.

🏎️ Installation

pnpm install -D @caido-community/dev

You can then access the binary via caido-dev. If you installed it local to your package, it can be run using pnpm exec caido-dev.

📟 CLI Commands

Build

caido-dev build [path] [--config <path-to-config>]

• Description: Build the Caido plugin.
• Options:
  • -c, --config <path>: Path to the caido.config.ts file.

Watch

caido-dev watch [path] [--config <path-to-config>]

• Description: Start the development server and watch for changes.
• Options:
  • -c, --config <path>: Path to the caido.config.ts file.

README Assets

Plugin packages always include the root README.md. Local README images are resized when needed and converted to compressed WebP data URIs during packaging, with each image limited to about 100 KiB before base64 encoding and the final README limited to about 2 MiB.

The packaged README is intended for self-contained rendering in Caido. Relative local image references are inlined, relative local non-image links are preserved, and fragment links such as #purpose are preserved. Unsupported URL schemes and absolute URLs, including http:, https:, protocol-relative URLs, javascript:, file:, blob:, and mailto:, are removed from Markdown and raw HTML URL attributes. Existing data:image URIs are preserved only in image contexts when they are small base64 raster images; other data: URLs are removed.