Build a plugin

For more information on the types of plugins you can build, refer to the Plugin Overview.

Get started

The easiest way to start developing Grafana plugins is to use the Grafana Toolkit.

Open the terminal, and run the following command in your plugin directory:

  1. npx @grafana/toolkit plugin:create my-grafana-plugin

Note: If running NPM 7+ the npx commands mentioned in this article may hang. The workaround is to use npx --legacy-peer-deps <command to run>.

If you want a more guided introduction to plugin development, check out our tutorials:

Learn more about specific areas of plugin development.

Tutorials

If you’re looking to build your first plugin, check out these introductory tutorials:

Improve an existing plugin with one of our guides:

Deepen your knowledge through a series of high-level overviews of plugin concepts:

Explore the many UI components in our Grafana UI library.

Examples

For inspiration, check out our plugin examples.

API reference

Learn more about Grafana options and packages.

Metadata

Go