ai-rulez 4.1.2 → 4.1.4
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 +80 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -165,16 +165,90 @@ args = ["-y", "ai-rulez@latest", "mcp"]
|
|
|
165
165
|
|
|
166
166
|
## Installation
|
|
167
167
|
|
|
168
|
+
No install needed — `npx ai-rulez@latest <command>` works out of the box. Pick a permanent option below:
|
|
169
|
+
|
|
170
|
+
<details>
|
|
171
|
+
<summary><strong>Homebrew (macOS / Linux)</strong></summary>
|
|
172
|
+
|
|
173
|
+
```bash
|
|
174
|
+
brew install goldziher/tap/ai-rulez
|
|
175
|
+
```
|
|
176
|
+
</details>
|
|
177
|
+
|
|
178
|
+
<details>
|
|
179
|
+
<summary><strong>npx (no install)</strong></summary>
|
|
180
|
+
|
|
168
181
|
```bash
|
|
169
|
-
# No install required
|
|
170
182
|
npx ai-rulez@latest <command>
|
|
183
|
+
```
|
|
184
|
+
</details>
|
|
171
185
|
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
186
|
+
<details>
|
|
187
|
+
<summary><strong>npm (global)</strong></summary>
|
|
188
|
+
|
|
189
|
+
```bash
|
|
190
|
+
npm install -g ai-rulez
|
|
191
|
+
```
|
|
192
|
+
</details>
|
|
193
|
+
|
|
194
|
+
<details>
|
|
195
|
+
<summary><strong>uvx (no install)</strong></summary>
|
|
196
|
+
|
|
197
|
+
```bash
|
|
198
|
+
uvx ai-rulez <command>
|
|
199
|
+
```
|
|
200
|
+
</details>
|
|
201
|
+
|
|
202
|
+
<details>
|
|
203
|
+
<summary><strong>uv tool</strong></summary>
|
|
204
|
+
|
|
205
|
+
```bash
|
|
206
|
+
uv tool install ai-rulez
|
|
177
207
|
```
|
|
208
|
+
</details>
|
|
209
|
+
|
|
210
|
+
<details>
|
|
211
|
+
<summary><strong>pip / pipx</strong></summary>
|
|
212
|
+
|
|
213
|
+
```bash
|
|
214
|
+
pip install ai-rulez
|
|
215
|
+
# or, isolated:
|
|
216
|
+
pipx install ai-rulez
|
|
217
|
+
```
|
|
218
|
+
</details>
|
|
219
|
+
|
|
220
|
+
<details>
|
|
221
|
+
<summary><strong>pre-commit hook</strong></summary>
|
|
222
|
+
|
|
223
|
+
Add to `.pre-commit-config.yaml`:
|
|
224
|
+
|
|
225
|
+
```yaml
|
|
226
|
+
repos:
|
|
227
|
+
- repo: https://github.com/Goldziher/ai-rulez
|
|
228
|
+
rev: v4.1.3
|
|
229
|
+
hooks:
|
|
230
|
+
- id: ai-rulez-recursive # generate outputs across the repo
|
|
231
|
+
- id: ai-rulez-validate # dry-run validation
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
Available hook ids: `ai-rulez-validate`, `ai-rulez-generate`, `ai-rulez-recursive`, `ai-rulez-enforce`, `ai-rulez-enforce-fix`. Triggers on changes under `.ai-rulez/`.
|
|
235
|
+
</details>
|
|
236
|
+
|
|
237
|
+
<details>
|
|
238
|
+
<summary><strong>lefthook</strong></summary>
|
|
239
|
+
|
|
240
|
+
Add to `lefthook.yml`:
|
|
241
|
+
|
|
242
|
+
```yaml
|
|
243
|
+
pre-commit:
|
|
244
|
+
commands:
|
|
245
|
+
ai-rulez:
|
|
246
|
+
glob: ".ai-rulez/**"
|
|
247
|
+
run: ai-rulez generate --recursive
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
Or run `ai-rulez setup-hooks` in a repo with an existing `lefthook.yml` to wire it in automatically.
|
|
251
|
+
</details>
|
|
178
252
|
|
|
179
253
|
## Documentation
|
|
180
254
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "ai-rulez",
|
|
3
|
-
"version": "4.1.
|
|
3
|
+
"version": "4.1.4",
|
|
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",
|