Skip to content

Commit 2923cef

Browse files
committed
adds formats to the docs
1 parent 54a1715 commit 2923cef

File tree

2 files changed

+21
-2
lines changed

2 files changed

+21
-2
lines changed

cmd/render.go

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,16 @@ var renderCmd = &cobra.Command{
1616
Copies all rules from the default location (.rules/) to the target format
1717
as described in render-formats.md.
1818
19-
Supported formats: continue, cursor, windsurf, claude, copilot, codex, cline, cody, amp`,
19+
Supported formats:
20+
continue - .continue/rules/*.md (Continue Dev rules)
21+
cursor - .cursor/rules/*.mdc (Cursor rules)
22+
windsurf - .windsurf/rules/*.md (Windsurf rules)
23+
claude - CLAUDE.md (Claude Code single file)
24+
copilot - .github/instructions/*.instructions.md (GitHub Copilot instructions)
25+
codex - AGENT.md (Codex single file)
26+
cline - .clinerules/*.md (Cline rules)
27+
cody - .sourcegraph/*.rule.md (Sourcegraph Cody rules)
28+
amp - AGENT.md (Amp single file)`,
2029
Example: ` rules render cursor
2130
rules render continue`,
2231
RunE: func(cmd *cobra.Command, args []string) error {

docs/docs/index.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,17 @@ To use rules with your AI IDE of choice, you can "render" them to the necessary
4444
rules render cursor
4545
```
4646

47-
will copy all of the `.rules/` into a `.cursor/rules/` folder. `rules` currently supports the following formats: cursor, continue, windsurf, claude, copilot, codex, cline, cody, and amp.
47+
will copy all of the `.rules/` into a `.cursor/rules/` folder. `rules` currently supports the following formats:
48+
49+
- **continue** - `.continue/rules/*.md` (Continue Dev rules)
50+
- **cursor** - `.cursor/rules/*.mdc` (Cursor rules)
51+
- **windsurf** - `.windsurf/rules/*.md` (Windsurf rules)
52+
- **claude** - `CLAUDE.md` (Claude Code single file)
53+
- **copilot** - `.github/instructions/*.instructions.md` (GitHub Copilot instructions)
54+
- **codex** - `AGENT.md` (Codex single file)
55+
- **cline** - `.clinerules/*.md` (Cline rules)
56+
- **cody** - `.sourcegraph/*.rule.md` (Sourcegraph Cody rules)
57+
- **amp** - `AGENT.md` (Amp single file)
4858

4959
## Publish rules
5060

0 commit comments

Comments
 (0)