grafana-plugin-scaffolding

Scaffold Grafana plugin projects using @grafana/create-plugin with Docker development environments.

Updated Jun 11, 2026
One-click install
npx skills add https://github.com/brillianodhiya/VisionScript --skill grafana-plugin-scaffolding-brillianodhiya
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: grafana-plugin-scaffolding
Source: https://github.com/brillianodhiya/VisionScript/tree/main/.agents/skills/grafana-plugin-scaffolding
Command: npx skills add https://github.com/brillianodhiya/VisionScript --skill grafana-plugin-scaffolding-brillianodhiya

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires @grafana/create-plugin, and includes scripts (resource) and references (resource) components.

What problem does it solve? Setting up a new Grafana plugin project involves many manual steps: running the official scaffolder, verifying prerequisites like Node.js and Docker, configuring plugin.json, and wiring up a local development environment. This Skill automates that entire bootstrap workflow for panel, data source, app, and backend plugins targeting Grafana v12.x+. ## Core Features & Use Cases - Automated Project Scaffolding: Wraps the official @grafana/create-plugin tool with prerequisite checks for Node.js v18+, npm, Docker, and Go. - Docker Dev Environment: Provides a docker-compose template with hot-reload via Docker Compose watch, plus a dev server script supporting start, stop, restart, logs, and status commands. - Plugin Configuration Templates: Ships ready-to-use plugin.json templates for panel, data source, app, and backend plugin types. - Use Case: A developer wants to build a custom data source plugin with a Go backend. The Skill verifies their toolchain, scaffolds the project, starts Grafana in Docker with unsigned plugin loading enabled, and points them to SDK patterns and E2E testing references. ## Quick Start Ask the assistant to scaffold a new Grafana panel plugin named my-panel for organization myorg and start the Docker development server.

Frequently Asked Questions about grafana-plugin-scaffolding

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a new Grafana plugin project?▼

Run npx @grafana/create-plugin@latest and follow the interactive prompts to select a plugin type, organization name, and plugin name. Then run npm install in the generated directory and start Grafana with docker compose up -d.

What plugin types can I scaffold with @grafana/create-plugin?▼

The scaffolder supports panel plugins for custom visualizations, data source plugins for connecting external data backends, and app plugins for multi-page applications. Data source and app plugins can optionally include a Go backend component.

Which Grafana versions does this scaffolding workflow support?▼

This workflow supports Grafana v12.x+ only, with plugin.json templates declaring grafanaDependency >=12.0.0. For older Grafana versions, consult the official migration guides before scaffolding.

Why is my Grafana plugin not appearing in the plugin list?▼

Check that plugin.json has a valid id field, verify the dist folder is correctly volume-mounted into the Grafana container, and ensure the plugin ID is listed in GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS. Restart Grafana and check logs with docker compose logs grafana.

Do I need a Go backend for my Grafana data source plugin?▼

A Go backend is required when you need alerting support, access to APIs unreachable from the browser, complex authentication like mTLS, streaming data, or heavy server-side processing. Frontend-only data sources work for CORS-enabled REST APIs with simple authentication.

How do I run E2E tests for a Grafana plugin?▼

Install @grafana/plugin-e2e and Playwright, then run npx playwright install --with-deps chromium. Start Grafana with docker compose up -d and execute npx playwright test, using fixtures like panelEditPage and createDataSourceConfigPage.