scaffold-project

Automate scaffolding of Grafana resources-as-code projects with go.mod, main.go, internal/, and README.md.

535|42|Updated Mar 23, 2026
One-click install
npx skills add https://github.com/grafana/gcx --skill scaffold-project-grafana
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: scaffold-project
Source: https://github.com/grafana/gcx/tree/main/claude-plugin/skills/scaffold-project
Command: npx skills add https://github.com/grafana/gcx --skill scaffold-project-grafana

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill automates the creation of Grafana resources-as-code projects, enabling teams to bootstrap new dashboards repos with a standardized structure and wiring for gcx.

Core Features & Use Cases

  • Interactive scaffolding: prompts for project name and Go module path to produce a ready-to-use repository layout.
  • Non-interactive scaffolding: supports command-line options to generate a predefined project skeleton without prompts.
  • Deterministic output: generates a consistent repository structure including go.mod, main.go, internal/, README.md, and a sample dashboards package.

Quick Start

Run gcx dev scaffold to generate a new dashboards-as-code project and follow the prompts for the project name and Go module path.

Frequently Asked Questions about scaffold-project

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

FAQPage Schema
How do I scaffold a new Grafana dashboards-as-code project?

Yes, the scaffolder supports non-interactive workflows by passing command-line options. This allows you to generate a predefined project skeleton without interactive prompts for project name or Go module path.

What files are generated when bootstrapping a Grafana resources-as-code repository?

Bootstrapping a Grafana resources-as-code repository produces a deterministic scaffold including go.mod, main.go, an internal directory, README.md, and a sample dashboards package for immediate development.

Can I automate Grafana project structure generation for CI pipelines?

You can automate Grafana project structure generation using the non-interactive scaffolding mode. By supplying command-line arguments for the project name and Go module path, it produces a standardized repository layout without requiring user input.

Do I need Go installed to generate a Grafana dashboards repository with this scaffolder?

Yes, Go is required because the generated scaffold produces Go-specific files including go.mod and main.go. The project is wired for gcx and uses a Go module path to structure the resources-as-code repository.

Why use a generator for Grafana dashboard repository structure?

Using a generator for Grafana dashboard repository structure ensures teams bootstrap new repos with a standardized layout. This eliminates manual setup inconsistencies and provides deterministic wiring for gcx resources-as-code projects.