Skip to content

Commit 9333780

Browse files
committed
fix: auth and update docs
1 parent eed58de commit 9333780

File tree

2 files changed

+9
-14
lines changed

2 files changed

+9
-14
lines changed

docs/docs/index.md

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -33,43 +33,36 @@ This will add them to your project in a local `.rules` folder.
3333
You can also download from GitHub rather than the rules registry:
3434

3535
```bash
36-
rules add gh:continuedev/continue-internal-rules
36+
rules add gh:continuedev/rules-template
3737
```
3838

3939
## Render rules
4040

4141
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,
4242

4343
```bash
44-
rules render continue
44+
rules render cursor
4545
```
4646

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.
4848

4949
## Publish rules
5050

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`:
5252

5353
```bash
5454
rules login
5555
rules publish
5656
```
5757

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>`.
5959

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`.
6861

6962
## Helping users use your rules
7063

7164
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.
7265

7366
1. Make your account on the [registry](https://hub.continue.dev/signup) and create an organization
7467
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

internal/config/config.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ type Config struct {
1515
Username string
1616
Email string
1717
Formats []string
18+
AppURL string
1819
}
1920

2021
// Initialize sets up the configuration from environment variables and Viper
@@ -63,6 +64,7 @@ func Initialize() (*Config, error) {
6364
Username: viper.GetString("username"),
6465
Email: viper.GetString("email"),
6566
Formats: viper.GetStringSlice("formats"),
67+
AppURL: viper.GetString("app_url"),
6668
}
6769

6870
return &config, nil

0 commit comments

Comments
 (0)