Section 2 · Build your plugin

The main parts of the project that create-plugin generates

Estimated time: 1 min

What the scaffolding tool creates

The create-plugin tool generates a project folder named after your answers, for example myorg-myplugin-datasource. Its main parts are:

  • src/: The frontend code, with starter code for your plugin type. plugin.json holds the plugin’s metadata, and module.ts (or module.tsx for app plugins) is its entry point.
  • pkg/: The Go backend code, only if you chose a backend component.
  • docker-compose.yaml: A local Grafana to test your plugin in.
  • README.md and CHANGELOG.md: Documentation you need when you publish.

What’s left for you

The scaffold doesn’t contain your plugin’s logic. That’s what you add next, yourself or with an AI coding assistant.