Create Grafana plugins with ease.
ToC
Links
@grafana/create-plugin
works on macOS, Linux and Windows Subsystem for Linux (WSL).
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.
Create Plugin can be used with NPM, PNPM or Yarn 1. The plugin will be scaffolded to use your preferred package manager. Run the command with the package manager of your choice:
npx @grafana/create-plugin@latest
pnpm dlx @grafana/create-plugin@latest
yarn dlx @grafana/create-plugin@latest
yarn create @grafana/pluginMigrate your existing plugin
â ï¸ We do not support plugins written in 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@latest migrate
For more information see here
Update your plugin build configIn 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@latest update
For more information see here
Customizing or extending the basic configsYou can read more about customizing or extending the basic configuration in our documentation.
Add provisioning to your existing pluginYou can streamline the plugin review process by incorporating provisioning into your existing plugin, enabling reviewers to test your plugin more efficiently.
# Run this command from the root of your plugin cd ./my-plugin npx @grafana/create-plugin@latest provisioning
For more information see our documentation.
We are always grateful for contributions! See CONTRIBUTING.md for more information.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4