Skip to content

Commit 87266c0

Browse files
dehumeneverett
authored andcommitted
[docs] Getting started page for AI tools (#21567)
Add a basic AI tools page to "Getting started". Not overly detailed on our AI skills, just a check advertisement and installation details ## Summary & Motivation ## Test Plan ## Changelog > The changelog is generated by an agent that examines merged PRs and > summarizes/categorizes user-facing changes. You can optionally replace > this text with a terse description of any user-facing changes in your PR, > which the agent will prioritize. Otherwise, delete this section. --------- Co-authored-by: Nikki Everett <neverett@users.noreply.github.com> Internal-RevId: a7230f11c2676b9236af873b3bd1116861cb2485
1 parent 918b2c8 commit 87266c0

8 files changed

Lines changed: 182 additions & 0 deletions

File tree

Lines changed: 181 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,181 @@
1+
---
2+
title: AI tools for Dagster
3+
description: Learn how to use Dagster's AI skills to build Dagster projects faster, with best practices built in.
4+
sidebar_label: AI tools
5+
---
6+
7+
Dagster maintains a set of AI skills that give coding agents better context and patterns for building Dagster projects. With these skills installed, your agent can help you create robust data pipelines according to Dagster best practices.
8+
9+
## About Dagster skills
10+
11+
A **skill** is a structured document that your AI coding agent loads when you invoke it. Skills tell agents what to do and how -- for example, which CLI commands to use, how to structure assets, and which patterns to follow.
12+
13+
Dagster maintains two skills in the [dagster-io/skills](https://github.com/dagster-io/skills) repository:
14+
15+
- **`dagster-expert`:** Expert guidance for building production-quality Dagster projects. Covers [`dg`](/api/clis/cli) CLI usage, asset patterns, automation strategies, and implementation workflows.
16+
- **`dignified-python`:** Production-quality Python coding standards for modern Python (types, exceptions, API design). Not Dagster-specific and can be used for general Python quality.
17+
18+
## Installing Dagster skills
19+
20+
<Tabs>
21+
<TabItem value="claude" label="Claude Code">
22+
23+
1. Install and sign in to [Claude Code](https://docs.anthropic.com/en/docs/claude-code/setup) using the setup guide.
24+
25+
2. In Claude Code, add the Dagster skills from the plugin marketplace:
26+
27+
```text
28+
/plugin marketplace add dagster-io/skills
29+
```
30+
31+
![Claude Code plugin marketplace showing the Dagster skills being added](/img/getting-started/ai-tools/claude-marketplace.png)
32+
33+
3. Install the skills you want to use from the plugin. For example, to install the `dagster-expert` skill, run the following command:
34+
35+
```text
36+
/plugin install dagster-expert@dagster-skills
37+
```
38+
39+
4. To confirm the skills are enabled, open the plugin list:
40+
41+
```text
42+
/plugin
43+
```
44+
45+
Switch to the **Installed** tab and confirm you see:
46+
47+
- **dagster-expert**: enabled
48+
- **dignified-python**: enabled
49+
50+
If any are disabled, enable them before continuing.
51+
52+
![Claude Code plugin list showing dagster-expert and dignified-python enabled](/img/getting-started/ai-tools/claude-plugin.png)
53+
54+
</TabItem>
55+
<TabItem value="cursor" label="Cursor">
56+
57+
:::info Prerequisites
58+
59+
To install Dagster skills with Cursor, you will need `npx`, which comes with Node.js. To install Node.js, see the [official website](https://nodejs.org).
60+
61+
:::
62+
63+
1. Install Cursor from [cursor.com](https://cursor.com) and sign in.
64+
65+
2. Use the `npx` command to install Dagster skills:
66+
67+
```bash
68+
npx skills add dagster-io/skills
69+
```
70+
71+
![Terminal output showing npx skills install completing successfully](/img/getting-started/ai-tools/npx-install.png)
72+
73+
3. To confirm the skills are enabled, open Cursor's Agent panel. You want at least:
74+
75+
- `dagster-expert`
76+
- `dignified-python`
77+
78+
![Cursor showing the Dagster skills available in the agent panel](/img/getting-started/ai-tools/cursor-skill.png)
79+
80+
</TabItem>
81+
<TabItem value="copilot" label="GitHub Copilot">
82+
83+
:::info Prerequisites
84+
85+
To install Dagster skills with GitHub Copilot, you will need `npx`, which comes with Node.js. To install Node.js, see the [official website](https://nodejs.org).
86+
87+
:::
88+
89+
1. Install the [GitHub Copilot extension](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot) and the [GitHub Copilot Chat extension](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot-chat) in VS Code, then sign in with your GitHub account.
90+
91+
2. In the Copilot Chat input bar, switch to **Agent** mode using the mode selector (look for the "Ask" / "Edit" dropdown). Without Agent mode, Copilot will suggest commands for you to run manually rather than executing them itself.
92+
93+
3. To add the Dagster skills, run the following command in your terminal:
94+
95+
```bash
96+
npx skills add dagster-io/skills
97+
```
98+
99+
![Terminal output showing npx skills install completing successfully](/img/getting-started/ai-tools/npx-install.png)
100+
101+
4. In the Copilot Chat panel, verify that the Dagster skills are enabled:
102+
103+
- `dagster-expert`
104+
- `dignified-python`
105+
106+
![GitHub Copilot Chat showing the Dagster skills available](/img/getting-started/ai-tools/copilot-skill.png)
107+
108+
</TabItem>
109+
<TabItem value="codex" label="Codex">
110+
111+
:::info Prerequisites
112+
113+
To install Dagster skills with Codex, you will need `npx`, which comes with Node.js. To install Node.js, see the [official website](https://nodejs.org).
114+
115+
:::
116+
117+
1. Install [Codex](https://openai.com/codex/) from the official setup guide and sign in.
118+
119+
2. To add the Dagster skills, run the following command in your terminal:
120+
121+
```bash
122+
npx skills add dagster-io/skills
123+
```
124+
125+
![Terminal output showing npx skills install completing successfully](/img/getting-started/ai-tools/npx-install.png)
126+
127+
3. In Codex settings or the skill list, confirm the Dagster skills are enabled:
128+
129+
- `dagster-expert`
130+
- `dignified-python`
131+
132+
![Codex showing the Dagster skills enabled](/img/getting-started/ai-tools/codex-skill.png)
133+
134+
</TabItem>
135+
</Tabs>
136+
137+
## Invoking Dagster skills
138+
139+
<Tabs>
140+
<TabItem value="claude" label="Claude Code">
141+
142+
In Claude Code, invoke the skill using the namespaced format:
143+
144+
```text
145+
/dagster-skills:dagster-expert create a new Dagster project called my-pipeline
146+
```
147+
148+
</TabItem>
149+
<TabItem value="cursor" label="Cursor">
150+
151+
In Cursor, invoke the skill by name:
152+
153+
```text
154+
/dagster-expert create a new Dagster project called my-pipeline
155+
```
156+
157+
</TabItem>
158+
<TabItem value="copilot" label="GitHub Copilot">
159+
160+
In GitHub Copilot, invoke the skill by name:
161+
162+
```text
163+
/dagster-expert create a new Dagster project called my-pipeline
164+
```
165+
166+
</TabItem>
167+
<TabItem value="codex" label="Codex">
168+
169+
In Codex, invoke the skill by name:
170+
171+
```text
172+
/dagster-expert create a new Dagster project called my-pipeline
173+
```
174+
175+
</TabItem>
176+
</Tabs>
177+
178+
## Next steps
179+
180+
- Follow the [Quickstart](/getting-started/quickstart) to scaffold your first Dagster project
181+
- Learn more in the [AI-Driven Data Engineering](https://courses.dagster.io/) course on Dagster University

docs/sidebars.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ const sidebars: SidebarsConfig = {
1111
'getting-started/quickstart-serverless',
1212
'getting-started/installation',
1313
'getting-started/concepts',
14+
'getting-started/ai-tools',
1415
{
1516
type: 'link',
1617
label: 'Dagster University',
126 KB
Loading
160 KB
Loading
645 KB
Loading
745 KB
Loading
698 KB
Loading
148 KB
Loading

0 commit comments

Comments
 (0)