Create Grafana plugins with ease.
ToC
Links
@grafana/create-plugin
works on macOS, Windows and Linux.
If something doesn't work, please file an issue.
If you have questions or need help, please ask in GitHub Discussions.
Run the command in the folder where you want to store your plugins. The new plugin will be scaffolded in a sub-directory of the folder where you run the command.
You can run the command with the package manager of your choice:
yarn
(1.x)
yarn create @grafana/plugin
yarn
(> 2.x)
yarn dlx @grafana/create-plugin
npx @grafana/create-plugin
npm init @grafana/plugin
angular
In case you have an existing plugin previously created using the @grafana/toolkit
you can use the
following command to migrate it to the new build tooling:
# Run this command from the root of your plugin
cd ./my-plugin
npx @grafana/create-plugin migrate
- If you have a custom webpack configuration you might need to migrate it. You can read more about customizing or extending the basic configuration here
- Build your plugin. Run
yarn build
to check your plugin builds as intended. - Test your plugin. Test your plugin inside grafana to confirm it is working as intended.
In case your plugin was using @grafana/toolkit
before make sure to migrate it first using npx @grafana/create-plugin migrate
.
As new Grafana versions come out we keep updating our plugin build tooling as well to stay compatible and to make it more performant.
In order to receive these changes and to make sure your plugin is compatible with the most recent Grafana versions you can use the update
command,
that automatically updates the build configuration for you:
# Run this command from the root of your plugin
cd ./my-plugin
npx @grafana/create-plugin update
You can read more about customizing or extending the basic configuration here
We are always grateful for contributions! See the CONTRIBUTING.md for more information.