<div align="center">
<img
src="./docusaurus/website/static/img/logo.svg"
alt="Grafana Logo"
width="100px"
padding="40px"
/>
<h1>Grafana Plugin tools</h1>
<p>Create and Sign Grafana plugins with ease.</p>
</div>
<div align="center">
<a href="https://github.com/grafana/plugin-tools/actions/workflows/ci.yml">
<img src="https://github.com/grafana/plugin-tools/actions/workflows/ci.yml/badge.svg" alt="Node CI" />
</a>
<a href="https://nodejs.org">
<img src="https://img.shields.io/badge/NPM-%23CB3837.svg?style=for-the-badge&logo=npm&logoColor=white" alt="NPM" />
</a>
<a href="https://nx.dev/">
<img src="https://img.shields.io/badge/nx-143055?style=for-the-badge&logo=nx&logoColor=white" alt="Nx" />
</a>
<br />
<br />
</div>
### Packages
This is a mono-repo of NPM packages to help plugin developers extend Grafana in amazing ways!
| Package Name | Description | Version | Downloads |
| ---------------------------------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| [**`@grafana/create-plugin`**](./packages/create-plugin/README.md) | A CLI tool for scaffolding a new plugin | [](https://www.npmjs.com/package/@grafana/create-plugin) | [](https://npmcharts.com/compare/@grafana/create-plugin?interval=7) |
| [**`@grafana/sign-plugin`**](./packages/sign-plugin/README.md) | A CLI tool for signing plugins | [](https://www.npmjs.com/package/@grafana/sign-plugin) | [](https://npmcharts.com/compare/@grafana/sign-plugin?interval=7) |
| [**`@grafana/plugin-e2e`**](./packages/plugin-e2e/README.md) | Test Grafana plugins with Playwright | [](https://www.npmjs.com/package/@grafana/plugin-e2e) | [](https://npmcharts.com/compare/@grafana/plugin-e2e?interval=7) |
| [**`@grafana/eslint-plugin-plugins`**](./packages/eslint-plugin-plugins/README.md) | Lint rules for Grafana plugins | [](https://www.npmjs.com/package/@grafana/eslint-plugin-plugins) | [](https://npmcharts.com/compare/@grafana/eslint-plugin-plugins?interval=7) |
| [**`@grafana/plugin-types-bundler`**](./packages/plugin-types-bundler/README.md) | Bundle Grafana plugin TypeScript types | [](https://www.npmjs.com/package/@grafana/plugin-types-bundler) | [](https://npmcharts.com/compare/@grafana/plugin-types-bundler?interval=7) |
| [**`@grafana/tsconfig`**](./packages/tsconfig/README.md) | Grafana's TypeScript config | [](https://www.npmjs.com/package/@grafana/tsconfig) | [](https://npmcharts.com/compare/@grafana/tsconfig?interval=7) |
| [**`@grafana/eslint-config`**](./packages/eslint-config/README.md) | Grafana's ESLint config | [](https://www.npmjs.com/package/@grafana/eslint-config) | [](https://npmcharts.com/compare/@grafana/eslint-config?interval=7) |
| [**`@grafana/plugin-meta-extractor`**](./packages/plugin-meta-extractor/README.md) | Extract metadata from plugin source code | [](https://www.npmjs.com/package/@grafana/plugin-meta-extractor) | [](https://npmcharts.com/compare/@grafana/plugin-meta-extractor?interval=7) |
| [**`@grafana/plugin-docs-cli`**](./packages/plugin-docs-cli/README.md) | Develop, validate, and preview plugin documentation locally | [](https://www.npmjs.com/package/@grafana/plugin-docs-cli) | [](https://npmcharts.com/compare/@grafana/plugin-docs-cli?interval=7) |
| [**`@grafana/plugin-docs-parser`**](./packages/plugin-docs-parser/README.md) | Parse plugin documentation from Markdown to HAST | [](https://www.npmjs.com/package/@grafana/plugin-docs-parser) | [](https://npmcharts.com/compare/@grafana/plugin-docs-parser?interval=7) |
| [**`@grafana/react-detect`**](./packages/react-detect/README.md) | Detect if a Grafana plugin is compatible with React 19 | [](https://www.npmjs.com/package/@grafana/react-detect) | [](https://npmcharts.com/compare/@grafana/react-detect?interval=7) |
### Overview
This Mono-repo uses [NPM](https://nodejs.org) for package management, [NX](https://nx.dev/) to efficiently orchestrate tasks across the codebase, and [Release Please](https://github.com/googleapis/release-please) for streamlined and automated package publishing. We've carefully chosen and integrated these technologies to enhance development workflows. Before diving into the codebase, make sure to consult the [contributing guide](./CONTRIBUTING.md) for a smooth collaboration experience.
### Additional resources
๐ Learn from tutorials and documentation in the [Grafana developer portal](https://grafana.com/developers).<br/>
โจ Gain inspiration from our [plugin examples](https://github.com/grafana/grafana-plugin-examples/) to get started quickly and implement new features in your plugin.<br/>
๐ ๏ธ Use the [Grafana plugin SDK for Go](https://github.com/grafana/grafana-plugin-sdk-go) to simplify the development of backend components.<br/>
โ
Ensure your plugin is ready for publishing to the [Grafana plugin catalog](https://grafana.com/grafana/plugins/) with our [validator](https://github.com/grafana/plugin-validator/) tool.
## Contributors โจ
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center"><a href="https://timur.digital/"><img src="https://avatars.githubusercontent.com/u/580672?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Timur Olzhabayev</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=tolzhabayev" title="Code">๐ป</a> <a href="#infra-tolzhabayev" title="Infrastructure (Hosting, Build-Tools, etc)">๐</a> <a href="https://github.com/grafana/plugin-tools/commits?author=tolzhabayev" title="Documentation">๐</a> <a href="https://github.com/grafana/plugin-tools/commits?author=tolzhabayev" title="Tests">โ ๏ธ</a></td>
<td align="center"><a href="https://guerra.in/"><img src="https://avatars.githubusercontent.com/u/16373015?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Giuseppe Guerra</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=xnyo" title="Code">๐ป</a></td>
<td align="center"><a href="https://www.heywesty.com/"><img src="https://avatars.githubusercontent.com/u/73201?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jack Westbrook</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=jackw" title="Code">๐ป</a> <a href="https://github.com/grafana/plugin-tools/commits?author=jackw" title="Documentation">๐</a> <a href="#infra-jackw" title="Infrastructure (Hosting, Build-Tools, etc)">๐</a> <a href="https://github.com/grafana/plugin-tools/commits?author=jackw" title="Tests">โ ๏ธ</a></td>
<td align="center"><a href="https://github.com/sunker"><img src="https://avatars.githubusercontent.com/u/2388950?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Erik Sundell</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=sunker" title="Code">๐ป</a> <a href="#infra-sunker" title="Infrastructure (Hosting, Build-Tools, etc)">๐</a> <a href="https://github.com/grafana/plugin-tools/commits?author=sunker" title="Documentation">๐</a> <a href="https://github.com/grafana/plugin-tools/commits?author=sunker" title="Tests">โ ๏ธ</a></td>
<td align="center"><a href="https://github.com/sarahzinger"><img src="https://avatars.githubusercontent.com/u/6620164?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sarah Zinger</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=sarahzinger" title="Documentation">๐</a> <a href="https://github.com/grafana/plugin-tools/commits?author=sarahzinger" title="Code">๐ป</a></td>
<td align="center"><a href="https://tomasbasham.dev/"><img src="https://avatars.githubusercontent.com/u/3389856?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Tomas Basham</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=tomasbasham" title="Documentation">๐</a> <a href="https://github.com/grafana/plugin-tools/commits?author=tomasbasham" title="Code">๐ป</a></td>
<td align="center"><a href="https://github.com/mckn"><img src="https://avatars.githubusercontent.com/u/172951?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Marcus Andersson</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=mckn" title="Documentation">๐</a> <a href="https://github.com/grafana/plugin-tools/commits?author=mckn" title="Tests">โ ๏ธ</a> <a href="https://github.com/grafana/plugin-tools/commits?author=mckn" title="Code">๐ป</a> <a href="#infra-mckn" title="Infrastructure (Hosting, Build-Tools, etc)">๐</a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/iwysiu"><img src="https://avatars.githubusercontent.com/u/5421859?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Isabella Siu</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=iwysiu" title="Code">๐ป</a></td>
<td align="center"><a href="https://github.com/romain-gaillard"><img src="https://avatars.githubusercontent.com/u/15131586?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Romain Gaillard</b></sub></a><br /><a href="#infra-romain-gaillard" title="Infrastructure (Hosting, Build-Tools, etc)">๐</a> <a href="https://github.com/grafana/plugin-tools/commits?author=romain-gaillard" title="Documentation">๐</a></td>
<td align="center"><a href="https://leventebalogh.com/"><img src="https://avatars.githubusercontent.com/u/9974811?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Levente Balogh</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=leventebalogh" title="Code">๐ป</a> <a href="https://github.com/grafana/plugin-tools/commits?author=leventebalogh" title="Documentation">๐</a> <a href="#infra-leventebalogh" title="Infrastructure (Hosting, Build-Tools, etc)">๐</a> <a href="https://github.com/grafana/plugin-tools/commits?author=leventebalogh" title="Tests">โ ๏ธ</a></td>
<td align="center"><a href="https://github.com/academo"><img src="https://avatars.githubusercontent.com/u/227916?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Esteban Beltran</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=academo" title="Code">๐ป</a> <a href="https://github.com/grafana/plugin-tools/commits?author=academo" title="Documentation">๐</a> <a href="https://github.com/grafana/plugin-tools/commits?author=academo" title="Tests">โ ๏ธ</a></td>
<td align="center"><a href="https://github.com/sympatheticmoose"><img src="https://avatars.githubusercontent.com/u/19860021?v=4?s=100" width="100px;" alt=""/><br /><sub><b>David Harris</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=sympatheticmoose" title="Code">๐ป</a> <a href="https://github.com/grafana/plugin-tools/commits?author=sympatheticmoose" title="Documentation">๐</a> <a href="#infra-sympatheticmoose" title="Infrastructure (Hosting, Build-Tools, etc)">๐</a></td>
<td align="center"><a href="https://bkgann.wordpress.com/"><img src="https://avatars.githubusercontent.com/u/7364245?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Brian Gann</b></sub></a><br /><a href="#infra-briangann" title="Infrastructure (Hosting, Build-Tools, etc)">๐</a></td>
<td align="center"><a href="https://github.com/dprokop"><img src="https://avatars.githubusercontent.com/u/2376619?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Dominik Prokop</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=dprokop" title="Documentation">๐</a> <a href="#infra-dprokop" title="Infrastructure (Hosting, Build-Tools, etc)">๐</a> <a href="https://github.com/grafana/plugin-tools/commits?author=dprokop" title="Code">๐ป</a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/josmperez"><img src="https://avatars.githubusercontent.com/u/45749060?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Joseph Perez</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=josmperez" title="Documentation">๐</a> <a href="#infra-josmperez" title="Infrastructure (Hosting, Build-Tools, etc)">๐</a> <a href="https://github.com/grafana/plugin-tools/commits?author=josmperez" title="Code">๐ป</a></td>
<td align="center"><a href="https://github.com/sd2k"><img src="https://avatars.githubusercontent.com/u/5464991?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ben Sully</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=sd2k" title="Documentation">๐</a> <a href="https://github.com/grafana/plugin-tools/commits?author=sd2k" title="Code">๐ป</a></td>
<td align="center"><a href="https://slorello.com/"><img src="https://avatars.githubusercontent.com/u/42971704?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Steve Lorello</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=slorello89" title="Documentation">๐</a></td>
<td align="center"><a href="https://github.com/Ukochka"><img src="https://avatars.githubusercontent.com/u/20494436?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Yulia Shanyrova</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=Ukochka" title="Documentation">๐</a> <a href="#infra-Ukochka" title="Infrastructure (Hosting, Build-Tools, etc)">๐</a> <a href="https://github.com/grafana/plugin-tools/commits?author=Ukochka" title="Code">๐ป</a></td>
<td align="center"><a href="https://github.com/aangelisc"><img src="https://avatars.githubusercontent.com/u/15019026?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Andreas Christou</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=aangelisc" title="Documentation">๐</a> <a href="https://github.com/grafana/plugin-tools/commits?author=aangelisc" title="Code">๐ป</a></td>
<td align="center"><a href="https://github.com/mikkancso"><img src="https://avatars.githubusercontent.com/u/13637610?v=4?s=100" width="100px;" alt=""/><br /><sub><b>mikkancso</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=mikkancso" title="Code">๐ป</a></td>
<td align="center"><a href="https://github.com/zoltanbedi"><img src="https://avatars.githubusercontent.com/u/13729989?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Zoltรกn Bedi</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=zoltanbedi" title="Documentation">๐</a> <a href="#infra-zoltanbedi" title="Infrastructure (Hosting, Build-Tools, etc)">๐</a> <a href="https://github.com/grafana/plugin-tools/commits?author=zoltanbedi" title="Code">๐ป</a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/joanlopez"><img src="https://avatars.githubusercontent.com/u/5459617?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Joan Lรณpez de la Franca Beltran</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=joanlopez" title="Code">๐ป</a></td>
<td align="center"><a href="https://ludovic-muller.fr/"><img src="https://avatars.githubusercontent.com/u/9420561?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ludovic Muller</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=ludovicm67" title="Code">๐ป</a></td>
<td align="center"><a href="https://grafana.com/"><img src="https://avatars.githubusercontent.com/u/43478413?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Grot (@grafanabot)</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=grafanabot" title="Code">๐ป</a> <a href="https://github.com/grafana/plugin-tools/commits?author=grafanabot" title="Documentation">๐</a> <a href="#infra-grafanabot" title="Infrastructure (Hosting, Build-Tools, etc)">๐</a></td>
<td align="center"><a href="https://www.nersc.gov/"><img src="https://avatars.githubusercontent.com/u/91281131?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Nicolas Ventura</b></sub></a><br /><a href="#infra-6nv" title="Infrastructure (Hosting, Build-Tools, etc)">๐</a></td>
<td align="center"><a href="https://oshirohugo.github.io/"><img src="https://avatars.githubusercontent.com/u/5558280?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Hugo Kiyodi Oshiro</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=oshirohugo" title="Code">๐ป</a> <a href="https://github.com/grafana/plugin-tools/commits?author=oshirohugo" title="Tests">โ ๏ธ</a> <a href="https://github.com/grafana/plugin-tools/commits?author=oshirohugo" title="Documentation">๐</a> <a href="#infra-oshirohugo" title="Infrastructure (Hosting, Build-Tools, etc)">๐</a></td>
<td align="center"><a href="https://github.com/kevinwcyu"><img src="https://avatars.githubusercontent.com/u/19530599?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Kevin Yu</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=kevinwcyu" title="Code">๐ป</a></td>
<td align="center"><a href="https://github.com/ashharrison90"><img src="https://avatars.githubusercontent.com/u/20999846?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ashley Harrison</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=ashharrison90" title="Code">๐ป</a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/ivanortegaalba"><img src="https://avatars.githubusercontent.com/u/5699976?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ivan Ortega Alba</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=ivanortegaalba" title="Code">๐ป</a></td>
<td align="center"><a href="https://github.com/s4kh"><img src="https://avatars.githubusercontent.com/u/15072209?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Syerikjan Kh</b></sub></a><br /><a href="#infra-s4kh" title="Infrastructure (Hosting, Build-Tools, etc)">๐</a> <a href="https://github.com/grafana/plugin-tools/commits?author=s4kh" title="Documentation">๐</a></td>
<td align="center"><a href="https://github.com/jalevin"><img src="https://avatars.githubusercontent.com/u/1669620?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jeff Levin</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=jalevin" title="Documentation">๐</a> <a href="https://github.com/grafana/plugin-tools/commits?author=jalevin" title="Code">๐ป</a></td>
<td align="center"><a href="http://matyax.com/"><img src="https://avatars.githubusercontent.com/u/1069378?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Matias Chomicki</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=matyax" title="Documentation">๐</a></td>
<td align="center"><a href="http://www.hugohaggmark.com/"><img src="https://avatars.githubusercontent.com/u/562238?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Hugo Hรคggmark</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=hugohaggmark" title="Documentation">๐</a> <a href="#infra-hugohaggmark" title="Infrastructure (Hosting, Build-Tools, etc)">๐</a> <a href="https://github.com/grafana/plugin-tools/commits?author=hugohaggmark" title="Tests">โ ๏ธ</a> <a href="https://github.com/grafana/plugin-tools/commits?author=hugohaggmark" title="Code">๐ป</a></td>
<td align="center"><a href="https://github.com/juanicabanas"><img src="https://avatars.githubusercontent.com/u/11707172?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Juan Cabanas</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=juanicabanas" title="Documentation">๐</a></td>
<td align="center"><a href="https://mattcowley.co.uk/"><img src="https://avatars.githubusercontent.com/u/12371363?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Matt Cowley</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=MattIPv4" title="Tests">โ ๏ธ</a> <a href="https://github.com/grafana/plugin-tools/commits?author=MattIPv4" title="Code">๐ป</a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/apps/renovate-sh-app"><img src="https://avatars.githubusercontent.com/u/7195757?v=4?s=100" width="100px;" alt=""/><br /><sub><b>renovate-sh-app[bot]</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=renovate-sh-app[bot]" title="Code">๐ป</a></td>
<td align="center"><a href="https://github.com/apps/grafana-plugins-platform-bot"><img src="https://avatars.githubusercontent.com/u/7195757?v=4?s=100" width="100px;" alt=""/><br /><sub><b>grafana-plugins-platform-bot[bot]</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=grafana-plugins-platform-bot[bot]" title="Code">๐ป</a></td>
<td align="center"><a href="http://www.paulmarbach.com/"><img src="https://avatars.githubusercontent.com/u/231133?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Paul Marbach</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=fastfrwrd" title="Code">๐ป</a> <a href="https://github.com/grafana/plugin-tools/commits?author=fastfrwrd" title="Documentation">๐</a></td>
<td align="center"><a href="https://github.com/urbiz-grafana"><img src="https://avatars.githubusercontent.com/u/218751872?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Anna Urbiztondo</b></sub></a><br /><a href="#infra-urbiz-grafana" title="Infrastructure (Hosting, Build-Tools, etc)">๐</a></td>
<td align="center"><a href="https://github.com/Sergej-Vlasov"><img src="https://avatars.githubusercontent.com/u/37613182?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sergej-Vlasov</b></sub></a><br /><a href="https://github.com/grafana/plugin-tools/commits?author=Sergej-Vlasov" title="Code">๐ป</a></td>
</tr>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!