ai-rulez 3.14.2 → 4.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +97 -67
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,16 +1,40 @@
|
|
|
1
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="docs/assets/logo.png" alt="AI-Rulez" width="200" />
|
|
3
|
+
</p>
|
|
2
4
|
|
|
3
|
-
|
|
5
|
+
<h1 align="center">ai-rulez</h1>
|
|
6
|
+
|
|
7
|
+
<p align="center">
|
|
8
|
+
<strong>Directory-based AI governance for 19+ tools</strong>
|
|
9
|
+
</p>
|
|
10
|
+
|
|
11
|
+
<p align="center">
|
|
12
|
+
<a href="https://goreportcard.com/report/github.com/Goldziher/ai-rulez"><img src="https://goreportcard.com/badge/github.com/Goldziher/ai-rulez" alt="Go Report Card"></a>
|
|
13
|
+
<a href="https://www.npmjs.com/package/ai-rulez"><img src="https://img.shields.io/npm/v/ai-rulez" alt="npm version"></a>
|
|
14
|
+
<a href="https://pypi.org/project/ai-rulez/"><img src="https://img.shields.io/pypi/v/ai-rulez" alt="PyPI version"></a>
|
|
15
|
+
<a href="https://github.com/Goldziher/ai-rulez/blob/main/LICENSE"><img src="https://img.shields.io/github/license/Goldziher/ai-rulez" alt="License"></a>
|
|
16
|
+
<a href="https://goldziher.github.io/ai-rulez/"><img src="https://img.shields.io/badge/docs-ai--rulez-blue" alt="Documentation"></a>
|
|
17
|
+
</p>
|
|
18
|
+
|
|
19
|
+
<p align="center">
|
|
20
|
+
Define rules, context, skills, agents and commands once — generate native configs for Claude, Cursor, Copilot, Windsurf, Gemini, Codex, and more.
|
|
21
|
+
</p>
|
|
22
|
+
|
|
23
|
+
---
|
|
4
24
|
|
|
5
25
|
Every AI coding tool wants its own config format. Claude needs `CLAUDE.md` + `.claude/skills/` + `.claude/agents/`, Cursor wants `.cursor/rules/`, Copilot expects `.github/copilot-instructions.md`. Keeping them in sync is tedious and error-prone.
|
|
6
26
|
|
|
7
|
-
ai-rulez solves this: organize your AI governance in `.ai-rulez/`, run `generate`, and get native configs for all your tools — with proper frontmatter, tool-specific formatting, and full feature support (skills, agents, MCP servers).
|
|
27
|
+
**ai-rulez** solves this: organize your AI governance in `.ai-rulez/`, run `generate`, and get native configs for all your tools — with proper frontmatter, tool-specific formatting, and full feature support (skills, agents, MCP servers, plugins).
|
|
8
28
|
|
|
9
29
|
```bash
|
|
10
30
|
npx ai-rulez@latest init && npx ai-rulez@latest generate
|
|
11
31
|
```
|
|
12
32
|
|
|
13
|
-
|
|
33
|
+
<p align="center">
|
|
34
|
+
<a href="https://goldziher.github.io/ai-rulez/"><strong>Documentation</strong></a> ·
|
|
35
|
+
<a href="https://goldziher.github.io/ai-rulez/quick-start/"><strong>Quick Start</strong></a> ·
|
|
36
|
+
<a href="https://goldziher.github.io/ai-rulez/examples/"><strong>Examples</strong></a>
|
|
37
|
+
</p>
|
|
14
38
|
|
|
15
39
|
## What You Get
|
|
16
40
|
|
|
@@ -20,6 +44,7 @@ npx ai-rulez@latest init && npx ai-rulez@latest generate
|
|
|
20
44
|
- **Remote includes**: Pull shared rules from git repos (company standards, team configs)
|
|
21
45
|
- **Profile system**: Generate different configs for backend/frontend/QA teams
|
|
22
46
|
- **MCP server**: Let AI assistants manage their own rules via Model Context Protocol
|
|
47
|
+
- **Plugins & Marketplaces**: Extend ai-rulez with custom generators and install pre-built rulesets from marketplaces
|
|
23
48
|
- **Type-safe schemas**: JSON Schema validation for all config files
|
|
24
49
|
|
|
25
50
|
## Quick Start
|
|
@@ -34,7 +59,7 @@ This creates:
|
|
|
34
59
|
|
|
35
60
|
```
|
|
36
61
|
.ai-rulez/
|
|
37
|
-
├── config.
|
|
62
|
+
├── config.toml # Which tools to generate for
|
|
38
63
|
├── rules/ # Guidelines AI must follow
|
|
39
64
|
├── context/ # Project background info
|
|
40
65
|
├── skills/ # Specialized AI roles
|
|
@@ -46,27 +71,32 @@ And generates native configs for each tool you specify.
|
|
|
46
71
|
|
|
47
72
|
## Configuration
|
|
48
73
|
|
|
49
|
-
```
|
|
50
|
-
# .ai-rulez/config.
|
|
51
|
-
version
|
|
52
|
-
name
|
|
74
|
+
```toml
|
|
75
|
+
# .ai-rulez/config.toml
|
|
76
|
+
version = "4.0"
|
|
77
|
+
name = "My Project"
|
|
78
|
+
|
|
79
|
+
presets = ["claude", "cursor", "copilot", "windsurf"]
|
|
53
80
|
|
|
54
|
-
|
|
55
|
-
- claude
|
|
56
|
-
- cursor
|
|
57
|
-
- copilot
|
|
58
|
-
- windsurf
|
|
81
|
+
builtins = ["security", "testing"]
|
|
59
82
|
|
|
60
83
|
# Optional: team-specific profiles
|
|
61
|
-
profiles
|
|
62
|
-
|
|
63
|
-
|
|
84
|
+
[profiles]
|
|
85
|
+
backend = ["backend", "database"]
|
|
86
|
+
frontend = ["frontend", "ui"]
|
|
64
87
|
|
|
65
88
|
# Optional: share rules across repos
|
|
66
|
-
includes
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
89
|
+
[[includes]]
|
|
90
|
+
name = "company-standards"
|
|
91
|
+
source = "https://github.com/company/ai-rules.git"
|
|
92
|
+
ref = "main"
|
|
93
|
+
|
|
94
|
+
# Optional: inline MCP servers
|
|
95
|
+
[[mcp_servers]]
|
|
96
|
+
name = "ai-rulez"
|
|
97
|
+
command = "npx"
|
|
98
|
+
args = ["-y", "ai-rulez@latest", "mcp"]
|
|
99
|
+
transport = "stdio"
|
|
70
100
|
```
|
|
71
101
|
|
|
72
102
|
## Content Structure
|
|
@@ -164,33 +194,33 @@ ai-rulez validate
|
|
|
164
194
|
# MCP server (for AI assistants)
|
|
165
195
|
npx ai-rulez@latest mcp
|
|
166
196
|
|
|
167
|
-
# Migrate from V2
|
|
168
|
-
ai-rulez migrate v3
|
|
169
197
|
```
|
|
170
198
|
|
|
171
199
|
## Remote Includes
|
|
172
200
|
|
|
173
201
|
Share rules across repositories:
|
|
174
202
|
|
|
175
|
-
```
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
203
|
+
```toml
|
|
204
|
+
# HTTPS
|
|
205
|
+
[[includes]]
|
|
206
|
+
name = "company-standards"
|
|
207
|
+
source = "https://github.com/company/ai-rules.git"
|
|
208
|
+
ref = "main"
|
|
209
|
+
include = ["rules", "context"]
|
|
210
|
+
merge_strategy = "local-override"
|
|
211
|
+
|
|
212
|
+
# SSH
|
|
213
|
+
[[includes]]
|
|
214
|
+
name = "shared-configs"
|
|
215
|
+
source = "git@github.com:org/shared-ai-rulez.git"
|
|
216
|
+
ref = "v2.0.0"
|
|
217
|
+
include = ["rules", "skills"]
|
|
218
|
+
|
|
219
|
+
# Local path
|
|
220
|
+
[[includes]]
|
|
221
|
+
name = "local-standards"
|
|
222
|
+
source = "../shared-rules"
|
|
223
|
+
include = ["rules"]
|
|
194
224
|
```
|
|
195
225
|
|
|
196
226
|
Private repos use `AI_RULEZ_GIT_TOKEN` environment variable or `--token` flag.
|
|
@@ -199,12 +229,14 @@ Private repos use `AI_RULEZ_GIT_TOKEN` environment variable or `--token` flag.
|
|
|
199
229
|
|
|
200
230
|
Install named skills from external repositories — fetched dynamically at generate time:
|
|
201
231
|
|
|
202
|
-
```
|
|
203
|
-
installed_skills
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
232
|
+
```toml
|
|
233
|
+
[[installed_skills]]
|
|
234
|
+
name = "kreuzberg"
|
|
235
|
+
source = "https://github.com/kreuzberg-dev/kreuzberg"
|
|
236
|
+
|
|
237
|
+
[[installed_skills]]
|
|
238
|
+
name = "ai-rulez"
|
|
239
|
+
source = "https://github.com/Goldziher/ai-rulez"
|
|
208
240
|
```
|
|
209
241
|
|
|
210
242
|
```bash
|
|
@@ -260,17 +292,21 @@ ai-rulez init --from .cursorrules,CLAUDE.md
|
|
|
260
292
|
|
|
261
293
|
## MCP Server
|
|
262
294
|
|
|
263
|
-
Let AI assistants manage rules directly
|
|
264
|
-
|
|
265
|
-
```
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
295
|
+
Let AI assistants manage rules directly. MCP servers are configured inline in `config.toml`:
|
|
296
|
+
|
|
297
|
+
```toml
|
|
298
|
+
[[mcp_servers]]
|
|
299
|
+
name = "ai-rulez"
|
|
300
|
+
command = "npx"
|
|
301
|
+
args = ["-y", "ai-rulez@latest", "mcp"]
|
|
302
|
+
transport = "stdio"
|
|
303
|
+
enabled = true
|
|
304
|
+
|
|
305
|
+
[[mcp_servers]]
|
|
306
|
+
name = "custom-server"
|
|
307
|
+
command = "python"
|
|
308
|
+
args = ["-m", "my_mcp_server"]
|
|
309
|
+
transport = "stdio"
|
|
274
310
|
```
|
|
275
311
|
|
|
276
312
|
The MCP server exposes CRUD operations, validation, and generation to AI assistants.
|
|
@@ -279,14 +315,8 @@ The MCP server exposes CRUD operations, validation, and generation to AI assista
|
|
|
279
315
|
|
|
280
316
|
27 built-in domains ship embedded in the binary — opinionated conventions ready to use without external includes:
|
|
281
317
|
|
|
282
|
-
```
|
|
283
|
-
builtins
|
|
284
|
-
- rust
|
|
285
|
-
- python
|
|
286
|
-
- typescript
|
|
287
|
-
- security
|
|
288
|
-
- testing
|
|
289
|
-
- default-commands
|
|
318
|
+
```toml
|
|
319
|
+
builtins = ["rust", "python", "typescript", "security", "testing", "default-commands"]
|
|
290
320
|
```
|
|
291
321
|
|
|
292
322
|
- **Universal** (9): `ai-governance`\*, `agent-delegation`\*, `security`, `git-workflow`, `code-quality`, `testing`, `token-efficiency`, `documentation`, `default-commands`
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "ai-rulez",
|
|
3
|
-
"version": "
|
|
4
|
-
"description": "Directory-based AI governance for Claude, Cursor, Copilot, Windsurf and
|
|
3
|
+
"version": "4.0.1",
|
|
4
|
+
"description": "Directory-based AI governance for Claude, Cursor, Copilot, Windsurf and 19+ tools. Define rules, context, skills and agents in .ai-rulez/ — generate synchronized configs for all your AI assistants.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"ai",
|
|
7
7
|
"ai-assistant",
|