ai-rulez 4.2.1 → 4.3.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.
Files changed (2) hide show
  1. package/README.md +21 -6
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -40,7 +40,7 @@ ai-rulez generates correct, tool-native output for **19 platforms**: Claude, Cur
40
40
 
41
41
  ## What Ships Out of the Box
42
42
 
43
- ai-rulez isn't just a config generator. It ships with **32 builtin domains** containing opinionated rules, agents, and workflows that establish a professional development baseline immediately.
43
+ ai-rulez isn't just a config generator. It ships with **33 builtin domains** containing opinionated rules, agents, and workflows that establish a professional development baseline immediately.
44
44
 
45
45
  ### Builtin Rules (auto-included)
46
46
 
@@ -77,7 +77,7 @@ Enable these based on your stack:
77
77
 
78
78
  **Bindings** (10): `pyo3`, `napi-rs`, `magnus`, `ext-php-rs`, `rustler`, `wasm`, `jni-rs`, `extendr`, `cgo`, `vite-plus`
79
79
 
80
- **Operational**: `cicd`, `docker`, `observability`, `documentation`, `default-commands`
80
+ **Operational**: `cicd`, `docker`, `observability`, `documentation`, `polyglot-bindings`, `default-commands`
81
81
 
82
82
  ```toml
83
83
  # .ai-rulez/config.toml
@@ -99,12 +99,14 @@ builtins = ["rust", "python", "pyo3", "cicd", "docker", "default-commands"]
99
99
  ai-rulez scales from solo projects to large organizations:
100
100
 
101
101
  **Domains** — Group content by feature, language, or team:
102
- ```
102
+
103
+ ```text
103
104
  .ai-rulez/domains/backend/rules/
104
105
  .ai-rulez/domains/frontend/rules/
105
106
  ```
106
107
 
107
108
  **Profiles** — Generate different configs for different audiences:
109
+
108
110
  ```toml
109
111
  [profiles]
110
112
  backend = ["backend", "database"]
@@ -112,6 +114,7 @@ frontend = ["frontend", "ui"]
112
114
  ```
113
115
 
114
116
  **Remote Includes** — Share rules across repositories:
117
+
115
118
  ```toml
116
119
  [[includes]]
117
120
  name = "company-standards"
@@ -120,6 +123,7 @@ merge_strategy = "local-override"
120
123
  ```
121
124
 
122
125
  **Reasoning effort across providers** — Tune how hard each AI tool thinks:
126
+
123
127
  ```yaml
124
128
  # .ai-rulez/agents/security-reviewer.md
125
129
  ---
@@ -128,6 +132,7 @@ description: Reviews code for security regressions
128
132
  effort: high
129
133
  ---
130
134
  ```
135
+
131
136
  ```toml
132
137
  # .ai-rulez/config.toml
133
138
  [defaults]
@@ -137,15 +142,19 @@ effort = "medium" # global default for every supported preset
137
142
  codex = "high" # overrides the global default for Codex
138
143
  claude = "xhigh" # …and for Claude
139
144
  ```
145
+
140
146
  Accepted values: `low`, `medium`, `high`, `xhigh`, `max`, `inherit`. ai-rulez emits the right field per preset:
147
+
141
148
  - **Claude** — `effort` in `.claude/agents/*.md` frontmatter (per-agent)
142
- - **Codex** — `model_reasoning_effort` in `.codex/config.toml` (global)
149
+ - **Codex** — `model_reasoning_effort` in `.codex/config.toml` and `.codex/agents/*.toml`
143
150
  - **Amp** — `amp.anthropic.effort` in `.amp/settings.json` (global)
144
151
  - **Windsurf** — `reasoning_effort` in `.windsurf/agents/*.md` frontmatter (per-agent)
152
+ - **Opencode** — `reasoningEffort` in `.opencode/agents/*.md` frontmatter (per-agent)
145
153
 
146
154
  Each preset maps the value to its own vocabulary; tools without a documented config surface (Cursor, Copilot, Gemini, etc.) are silently skipped. See [docs/configuration.md](docs/configuration.md#defaults) for the full mapping table.
147
155
 
148
156
  **Installed Skills** — Pull reusable skills from external repos:
157
+
149
158
  ```toml
150
159
  [[installed_skills]]
151
160
  name = "kreuzberg"
@@ -173,6 +182,7 @@ No install needed — `npx ai-rulez@latest <command>` works out of the box. Pick
173
182
  ```bash
174
183
  brew install goldziher/tap/ai-rulez
175
184
  ```
185
+
176
186
  </details>
177
187
 
178
188
  <details>
@@ -181,6 +191,7 @@ brew install goldziher/tap/ai-rulez
181
191
  ```bash
182
192
  npx ai-rulez@latest <command>
183
193
  ```
194
+
184
195
  </details>
185
196
 
186
197
  <details>
@@ -189,6 +200,7 @@ npx ai-rulez@latest <command>
189
200
  ```bash
190
201
  npm install -g ai-rulez
191
202
  ```
203
+
192
204
  </details>
193
205
 
194
206
  <details>
@@ -197,6 +209,7 @@ npm install -g ai-rulez
197
209
  ```bash
198
210
  uvx ai-rulez <command>
199
211
  ```
212
+
200
213
  </details>
201
214
 
202
215
  <details>
@@ -205,6 +218,7 @@ uvx ai-rulez <command>
205
218
  ```bash
206
219
  uv tool install ai-rulez
207
220
  ```
221
+
208
222
  </details>
209
223
 
210
224
  <details>
@@ -215,6 +229,7 @@ pip install ai-rulez
215
229
  # or, isolated:
216
230
  pipx install ai-rulez
217
231
  ```
232
+
218
233
  </details>
219
234
 
220
235
  <details>
@@ -225,7 +240,7 @@ Add to `.pre-commit-config.yaml`:
225
240
  ```yaml
226
241
  repos:
227
242
  - repo: https://github.com/Goldziher/ai-rulez
228
- rev: v4.1.3
243
+ rev: v4.3.1
229
244
  hooks:
230
245
  - id: ai-rulez-recursive # generate outputs across the repo
231
246
  - id: ai-rulez-validate # dry-run validation
@@ -247,7 +262,7 @@ pre-commit:
247
262
  run: ai-rulez generate --recursive
248
263
  ```
249
264
 
250
- Or run `ai-rulez setup-hooks` in a repo with an existing `lefthook.yml` to wire it in automatically.
265
+ Or run `ai-rulez init --setup-hooks` while initializing a repo to wire hooks in automatically.
251
266
  </details>
252
267
 
253
268
  ## Documentation
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ai-rulez",
3
- "version": "4.2.1",
3
+ "version": "4.3.1",
4
4
  "description": "Complete AI development workflow for 19+ tools. Ships with builtin rules, agents, and conventions. Generate native configs for Claude, Cursor, Copilot, Windsurf, Gemini, Codex and more from a single source.",
5
5
  "keywords": [
6
6
  "ai",