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/docs/index.md
+7-14Lines changed: 7 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,43 +33,36 @@ This will add them to your project in a local `.rules` folder.
33
33
You can also download from GitHub rather than the rules registry:
34
34
35
35
```bash
36
-
rules add gh:continuedev/continue-internal-rules
36
+
rules add gh:continuedev/rules-template
37
37
```
38
38
39
39
## Render rules
40
40
41
41
To use rules with your AI code assistant of choice, you can "render" them to the necessary format and location using `rules render`. For example,
42
42
43
43
```bash
44
-
rules render continue
44
+
rules render cursor
45
45
```
46
46
47
-
will copy all of the `.rules/` into a `.continue/rules/` folder.
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.
48
48
49
49
## Publish rules
50
50
51
-
To make your rule available to others, you can publish a markdown file using `rules publish`:
51
+
To make your rules available to others, you can publish using `rules publish`:
52
52
53
53
```bash
54
54
rules login
55
55
rules publish
56
56
```
57
57
58
-
This would make your rule available to download with `rules add <your-username>/<your-ruleset-name>`.
58
+
This would make your rule available to download with `rules add <name-of-rules>`.
59
59
60
-
The command automatically determines the slug from your `rules.json` file and your authenticated user information. Make sure you have a `rules.json` file in your current directory with a `name` field, and an `index.md` file containing your rule content.
61
-
62
-
<!--
63
-
You can also publish a folder of markdown files:
64
-
65
-
```bash
66
-
rules publish ./my-rules
67
-
``` -->
60
+
The command automatically determines the slug from your `rules.json` file. To make sure you have a `rules.json` file in your current directory, use `rules init`.
68
61
69
62
## Helping users use your rules
70
63
71
64
If you are building a developer tool and want to optimize how AI IDEs work with your tool, `rules` makes it easy to give your users the best experience.
72
65
73
66
1. Make your account on the [registry](https://hub.continue.dev/signup) and create an organization
74
67
2.[Publish your rules](index.md#publish-rules)
75
-
3. Mention the corresponding `rules add <my-rules>` command in your documentation
68
+
3. Mention the corresponding `rules add <name-of-rules>` command in your documentation
0 commit comments