Skip to content

Examples

The repository includes example plugins you can copy, rename, and adapt while building your own tools.

  • examples/plugins/hello-world Minimal Rust plugin. Good for understanding the smallest manifest and tool surface.
  • examples/plugins/ts-hello-world Smallest AssemblyScript example. Good for learning the manifest format, the plugin exports, and the basic host API.
  • examples/plugins/obsidian-wiki Workspace-oriented plugin that manages markdown notes inside the active project root.
  • examples/plugins/web-search Rust plugin example that shows an alternative implementation language.
  • apps/desktop/plugins/calendar Example plugin with a sidebar panel and a main content panel declared through [[ui.tabs]].
  • apps/desktop/plugins/pomodoro Example plugin with a richer interactive desktop UI tab backed by plugin storage and tools.
  • manifest structure
  • host calls
  • tool naming
  • desktop UI tab registration
  • packaging flow
  1. Copy ts-hello-world.
  2. Change the plugin identity in plugin.toml.
  3. Replace the sample tools with your own.
  4. Keep permissions as narrow as possible while you develop.