How do I install the Scaffold Project skill?

Run npx skillmds@latest add grafana/scaffold-project in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Scaffold Project safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Scaffold Project?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Scaffold Project free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Scaffold Project?

grafana (@grafana) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Scaffold Project by grafana — Agent Skill

Name: Scaffold Project
Author: grafana

Scaffold Project

Scaffolds a new Go project for managing Grafana resources as code via gcx dev scaffold. Use when the user wants to create a new Grafana resources-as-code project, start a new dashboards-as-code repo, scaffold a gcx project, or asks "how do I get started with gcx". Triggers on phrases like "new project", "scaffold", "bootstrap", "create project", "get started".

grafana 9637da9 2.2 KB Updated Sep 17, 2026

File contents

Scaffold a gcx Project

Scaffold a new Go project for managing Grafana resources as code using gcx dev scaffold.

Prerequisites

Verify gcx is installed:

gcx --version

If missing, see the setup-gcx skill.

Scaffolding

Interactive Mode (recommended for first-time users)

gcx dev scaffold

Prompts for:

Project name - becomes the directory name (kebab-cased)
Go module path - e.g. github.com/myorg/my-dashboards

Non-Interactive Mode

gcx dev scaffold --project my-dashboards --go-module-path github.com/myorg/my-dashboards

What Gets Generated

my-dashboards/
├── .github/workflows/deploy.yaml   # CI/CD workflow for gcx push
├── .gitignore
├── go.mod
├── main.go                         # Entrypoint — registers all resources
├── internal/
│   └── dashboards/
│       ├── all.go                  # Registry function returning all manifests
│       └── sample.go              # Example dashboard using foundation-sdk builders
└── README.md

Next Steps After Scaffolding

cd my-dashboards && go mod tidy
Configure gcx: gcx config set stacks.default.grafana.server <URL>, gcx config set stacks.default.grafana.token <TOKEN>, and gcx config set contexts.default.stack default
Edit internal/dashboards/sample.go or generate new stubs with gcx dev generate
Push to Grafana: gcx resources push

Common Issues

Issue	Fix
`go mod tidy` fails	Ensure your Go toolchain meets the version required by the generated `go.mod`
Project name has spaces	Names are auto-kebab-cased; spaces become hyphens
Want to add alert rules	Create `internal/alerts/` and use `gcx dev generate alerts/my-rule.go`

---name: scaffold-projectdescription: Scaffolds a new Go project for managing Grafana resources as code via gcx dev scaffold. Use when the user wants to create a new Grafana resources-as-code project, start a new dashboards-as-code repo, scaffold a gcx project, or asks "how do I get started with gcx". Triggers on phrases like "new project", "scaffold", "bootstrap", "create project", "get started".---# Scaffold a gcx ProjectScaffold a new Go project for managing Grafana resources as code using`gcx dev scaffold`.## PrerequisitesVerify gcx is installed:```bashgcx --version```If missing, see the `setup-gcx` skill.## Scaffolding### Interactive Mode (recommended for first-time users)```bashgcx dev scaffold```Prompts for:- **Project name** - becomes the directory name (kebab-cased)- **Go module path** - e.g. `github.com/myorg/my-dashboards`### Non-Interactive Mode```bashgcx dev scaffold --project my-dashboards --go-module-path github.com/myorg/my-dashboards```## What Gets Generated```my-dashboards/├── .github/workflows/deploy.yaml # CI/CD workflow for gcx push├── .gitignore├── go.mod├── main.go # Entrypoint — registers all resources├── internal/│ └── dashboards/│ ├── all.go # Registry function returning all manifests│ └── sample.go # Example dashboard using foundation-sdk builders└── README.md```## Next Steps After Scaffolding1. `cd my-dashboards && go mod tidy`2. Configure gcx: `gcx config set stacks.default.grafana.server <URL>`, `gcx config set stacks.default.grafana.token <TOKEN>`, and `gcx config set contexts.default.stack default`3. Edit `internal/dashboards/sample.go` or generate new stubs with `gcx dev generate`4. Push to Grafana: `gcx resources push`## Common Issues| Issue | Fix ||-------|-----|| `go mod tidy` fails | Ensure your Go toolchain meets the version required by the generated `go.mod` || Project name has spaces | Names are auto-kebab-cased; spaces become hyphens || Want to add alert rules | Create `internal/alerts/` and use `gcx dev generate alerts/my-rule.go` |

Frequently asked questions