create-custom-dagster-component

Scaffold and validate Dagster components using the dg CLI.

Updated Dec 5, 2025
One-click install
npx skills add https://github.com/cnolanminich/dagster-project-claude-files --skill create-custom-dagster-component
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: create-custom-dagster-component
Source: https://github.com/cnolanminich/dagster-project-claude-files/tree/main/.claude/skills/create-custom-dagster-component
Command: npx skills add https://github.com/cnolanminich/dagster-project-claude-files --skill create-custom-dagster-component

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill automates the creation and validation of a new custom Dagster component using the dg CLI, including optional demo-mode support and realistic asset scaffolding.

Core Features & Use Cases

  • Scaffold a new Dagster Component with dg scaffold component <ComponentName>.
  • Implement demo_mode logic and 3-5 realistic assets with dependencies.
  • Validate component loading with dg check defs and dg list defs to ensure assets are loaded correctly.
  • Optionally create a custom scaffolder for streamlined component instantiation.
  • Create a component instance YAML scaffold for demo or production usage.

Quick Start

uv run dg scaffold component <ComponentName> uv run dg scaffold defs my_module.components.ComponentName my_component uv run dg check defs

Frequently Asked Questions about create-custom-dagster-component

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

FAQPage Schema
How do I scaffold a new Dagster component with demo mode?▼

You can scaffold a Dagster component using the `dg scaffold component <ComponentName>` CLI command. This automates the creation of demo-mode logic and realistic asset scaffolding while ensuring asset keys remain identical across demo and production modes.

How does dg check defs validate Dagster component loading?▼

The `dg check defs` command validates that newly scaffolded Dagster components load correctly. It runs automated checks against your definitions to ensure production-ready assets and dependencies are properly resolved before deployment.

Can I generate a component instance YAML scaffold for Dagster production usage?▼

Yes, this process optionally creates a component instance YAML scaffold for demo or production usage. It enforces YAML frontmatter with a name and description to ensure the Dagster component is instantiated correctly.

What is the best way to maintain identical asset keys across demo and production modes in Dagster?▼

The best way to maintain identical asset keys across demo and production modes is to use the dg CLI scaffolder. It enforces key consistency during component creation so that demo-mode logic and production-ready assets resolve to the same dependencies.

Do I need the dg CLI to create custom Dagster components?▼

Yes, the dg CLI is required to create custom Dagster components using this approach. It provides the necessary `dg scaffold` and `dg check defs` commands to generate scaffolding and validate definitions for production-ready assets.