You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/workspace/agent-panel.md
+64-20Lines changed: 64 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,7 +56,7 @@ The AI automatically has access to:
56
56
- The widget you currently have selected
57
57
- Recent changes you've made
58
58
- Your project's dependencies and configuration
59
-
- Your project-level guideline files (.cursorrules, CLAUDE.md, AGENTS.md, or ARCHITECTURE.md) to keep generated code consistent.
59
+
- Your project-level guideline files to keep generated code consistent.
60
60
61
61
62
62
### Image Attachments
@@ -231,30 +231,18 @@ Without project rules, you repeat long instructions in every prompt, for example
231
231
Add a login screen and use the BLoC pattern for state management, follow Clean Architecture, and place new features under /features/...
232
232
```
233
233
234
-
With project rules, you can define these standards once in a file such as [`AGENTS.md`](http://AGENTS.md)and then simply ask:
234
+
With project rules, you can define these standards once and then simply ask:
235
235
236
236
```
237
237
Add a login screen.
238
238
```
239
239
240
-
#### Supported Rule Files
241
-
242
-
Dreamflow looks for one of the following files in your project root:
243
-
244
-
| Priority | Filename | Typical Purpose |
245
-
| --- | --- | --- |
246
-
| 1️⃣ |**.cursorrules**| Originally designed for the Cursor IDE but supported in Dreamflow for compatibility with existing codebases. |
247
-
| 2️⃣ |[**CLAUDE.md**](https://code.claude.com/docs/en/overview)| Anthropic-style AI instruction file that can include guidelines for tone, safety, or project-specific context. |
248
-
| 3️⃣ |[**AGENTS.md**](https://agents.md/)| Defines how AI agents should behave in your project, including coding standards, architecture patterns, and testing rules. |
249
-
| 4️⃣ |[**ARCHITECTURE.md**](https://architecture.md/)| Documents your project’s structure, data flow, and design philosophy for better context. |
250
240
251
241
:::info
252
-
253
-
Only the **first file found** in this order is loaded. If multiple exist, Dreamflow stops scanning after the first match. For example, if .cursorrules exists, it will be used even if `AGENTS.md` is also present.
254
-
242
+
Dreamflow supports common rule file formats such as [**`CLAUDE.md`**](https://code.claude.com/docs/en/overview), **`.cursorrules`**, and [**`ARCHITECTURE.md`**](https://architecture.md/), but it is **recommended to use the [`AGENTS.md`](https://agents.md/) file**.
255
243
:::
256
244
257
-
When any of the supported rule files is loaded into the Agent’s context:
245
+
When the rule file is loaded into the Agent’s context:
258
246
259
247
- The file’s contents are **appended to the system prompt** and used to fine-tune how the Agent generates, edits, and structures code.
260
248
- These rules are applied to **every Agent action**, ensuring consistent behavior across your entire project.
@@ -266,7 +254,35 @@ Follow these steps to add project rules:
266
254
267
255
**Step 1: Create Rule File**
268
256
269
-
Create one of the supported rule files with the help of ChatGPT or Claude. While creating the file, include your project’s coding standards, architecture pattern, folder structure, testing requirements, and security guidelines.
257
+
To create a rule, open the **Agent** panel, select the **Rules** button, and click **Generate AGENTS.md**. Once the file is created, it will appear in the project root.
258
+
259
+
<div style={{
260
+
position: 'relative',
261
+
paddingBottom: 'calc(52.67989417989418% + 41px)', // Keeps the aspect ratio and additional padding
You can also manually create rule files with the help of ChatGPT or Claude. While creating the file, include your project’s coding standards, architecture pattern, folder structure, testing requirements, and security guidelines.
270
286
271
287
Here’s a sample prompt you can use to generate your `AGENTS.md` file:
**2. Nested Rule File (Feature-Specific Rules)**: You may also create **`AGENTS.md` files inside subfolders**, such as:
347
+
348
+
```
349
+
/features/auth/AGENTS.md
350
+
/features/chat/AGENTS.md
351
+
/lib/widgets/common/AGENTS.md
352
+
```
353
+
354
+
Dreamflow will load these **only when the Agent is generating or editing code inside that folder**. Use nested rule files for:
355
+
356
+
- Feature-specific architecture
357
+
- Module boundaries
358
+
- API constraints
359
+
- UI or widget conventions
360
+
- Domain-level rules
361
+
319
362
**Step 3: Run Agent Action**
320
363
321
364
You can view or edit your rule file anytime from the Dreamflow File Editor. Once it’s saved, run any Agent command (for example, “Add a login screen”). Dreamflow will automatically load your rules and apply them to every generation.
322
365
323
366
#### Best Practices
324
-
367
+
- Keep the root-level `AGENTS.md` small and focused.
368
+
- Use nested `AGENTS.md` files for detailed, module-specific rules to avoid bloating the Agent’s context.
325
369
- Keep the rule file specific, short, and imperative.
326
370
- Keep must-follow standards at the top of the file.
327
371
- Avoid overly long explanations — keep it concise and readable.
0 commit comments