What is the recommended way to create Grafana plugin?

The Build a plugin tutorial is currently using

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

And this package @grafana/toolkit is bumping version all the time.

It can create 3 template plugins Panel Plugin, Datasource Plugin, Backend Datasource Plugin.

However, after generating these plugins, in their README.md, it says

:warning: Deprecated!

This repository is deprecated.

A more up-to-date version of examples is available here: GitHub - grafana/grafana-plugin-examples

If this above repo is the recommended way now. Maybe worth updating the Build a plugin
tutorial? Thanks! :smiley:

1 Like

I further found inside of grafana-plugin-examples README, it says

All of the examples use grafana/create-plugin instead of @grafana/toolkit.

Inside of grafana/create-plugin README, I further found the new CLI way to create plugin:

yarn (1.x)
yarn create @grafana/plugin

yarn (> 2.x)
yarn dlx @grafana/create-plugin

npx @grafana/create-plugin

npm init @grafana/plugin

So maybe should put these new CLI commands in the tutorial? :smiley:


I feel your pain! I am building a plugin this morning and it is torturous to follow this antiquated doco

Best way is to alert people in this forum that work @ grafana or post it go githug

Sounds good @yosiasz ! :smiley:
I posted at Update Grafana plugin tutorial to use new `@grafana/create-plugin` · Issue #58191 · grafana/grafana · GitHub

or modify it yourself by forking?

I created more issue tickets I found in the GitHub too. For sure if I have time! :smiley:

1 Like

This topic was automatically closed 365 days after the last reply. New replies are no longer allowed.