ai-rulez 5.11.0 → 5.11.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 +32 -216
  2. package/package.json +9 -52
package/README.md CHANGED
@@ -2,244 +2,60 @@
2
2
  <img src="https://raw.githubusercontent.com/Goldziher/ai-rulez/main/docs/assets/ai-rulez-banner.png" alt="AI-Rulez" width="820" />
3
3
  </p>
4
4
 
5
- <p align="center">
6
- <strong>One source for the rules, skills and settings of every AI coding assistant</strong>
7
- </p>
5
+ # ai-rulez
8
6
 
9
- <p align="center">
10
- <a href="https://www.npmjs.com/package/ai-rulez"><img src="https://img.shields.io/npm/v/ai-rulez?color=blue" alt="npm version"></a>
11
- <a href="https://pypi.org/project/ai-rulez/"><img src="https://img.shields.io/pypi/v/ai-rulez?color=blue" alt="PyPI version"></a>
12
- <a href="https://github.com/Goldziher/homebrew-tap"><img src="https://img.shields.io/github/v/release/Goldziher/ai-rulez?label=homebrew&color=blue" alt="Homebrew version"></a>
13
- <a href="https://pkg.go.dev/github.com/Goldziher/ai-rulez/v5"><img src="https://img.shields.io/github/v/release/Goldziher/ai-rulez?label=go&color=blue" alt="Go version"></a>
14
- <a href="https://github.com/Goldziher/ai-rulez/blob/main/LICENSE"><img src="https://img.shields.io/github/license/Goldziher/ai-rulez?color=blue" alt="License"></a>
15
- <a href="https://goldziher.github.io/ai-rulez/"><img src="https://img.shields.io/badge/docs-ai--rulez-blue" alt="Documentation"></a>
16
- </p>
17
-
18
- <p align="center">
19
- <a href="https://goldziher.github.io/ai-rulez/"><strong>Documentation</strong></a> &middot;
20
- <a href="https://goldziher.github.io/ai-rulez/quick-start/"><strong>Quick Start</strong></a> &middot;
21
- <a href="https://goldziher.github.io/ai-rulez/examples/"><strong>Examples</strong></a>
22
- </p>
7
+ [![npm version](https://img.shields.io/npm/v/ai-rulez?color=blue)](https://www.npmjs.com/package/ai-rulez)
8
+ [![License](https://img.shields.io/github/license/Goldziher/ai-rulez?color=blue)](https://github.com/Goldziher/ai-rulez/blob/main/LICENSE)
23
9
 
10
+ One source for the rules, skills and settings of every AI coding assistant. ai-rulez keeps them in a single `.ai-rulez/` directory and generates the native files of 52 tools (`AGENTS.md`, `CLAUDE.md`, `.cursor/rules/`, skills, MCP and settings files), then validates, locks, signs and publishes them.
24
11
 
25
- ---
12
+ Documentation: [goldziher.github.io/ai-rulez](https://goldziher.github.io/ai-rulez/)
26
13
 
27
- ## What it is
28
-
29
- ai-rulez keeps the instructions for your AI coding assistants in one directory, `.ai-rulez/`: rules, context, skills,
30
- agents, commands, hooks, permissions and MCP servers. From that source it generates the native files of each assistant
31
- your team uses (`AGENTS.md`, `CLAUDE.md`, `.cursor/rules/`, `.github/instructions/`, skill folders, MCP and settings
32
- files) for 52 tools, and keeps them in sync.
33
-
34
- - **One source, every tool.** Edit `.ai-rulez/`, run `generate`, and Claude Code, Cursor, Codex, Copilot, Gemini CLI
35
- and the rest get the same guidance in their own format.
36
- - **Checked in CI.** `generate --check` catches drift; `validate` lints content, links and security issues with stable
37
- `AR` rule codes, and also works on plain `AGENTS.md` and `SKILL.md` files with no configuration.
38
- - **Governed like dependencies.** A lock file pins remote includes, installed skills and authored content; approvals,
39
- Sigstore signatures, SBOMs and an organization policy cover the rest.
40
- - **Packaged for distribution.** Build plugin bundles and marketplaces, Agent Plugins and ARD manifests, and publish
41
- them.
14
+ ## Install
42
15
 
43
- ## 30-second example
16
+ Requires Node.js 22 or newer.
44
17
 
45
18
  ```bash
46
- npx ai-rulez@latest init acme
19
+ npm install -g ai-rulez
47
20
  ```
48
21
 
49
- Set the tools you use in `.ai-rulez/config.toml`:
50
-
51
- ```toml
52
- version = "5.0"
53
- name = "acme"
54
- presets = ["claude", "cursor", "codex", "copilot", "gemini"]
55
- ```
56
-
57
- Add a rule and generate:
22
+ Or run it without installing:
58
23
 
59
24
  ```bash
60
- npx ai-rulez@latest add rule testing --content '# Testing
61
-
62
- - Every bug fix ships with a regression test.'
63
- npx ai-rulez@latest generate
64
- ```
65
-
66
- ```text
67
- AGENTS.md # rules and context, read by Codex, Cursor, Copilot and Gemini CLI
68
- CLAUDE.md # imports @AGENTS.md for Claude Code
69
- .agents/skills/ # skills
70
- .claude/skills/
71
- .gemini/settings.json # points Gemini CLI at AGENTS.md
72
- .mcp.json, .cursor/mcp.json, .vscode/mcp.json, .codex/config.toml
25
+ npx ai-rulez@latest init acme
73
26
  ```
74
27
 
75
- Commit `.ai-rulez/` with the generated files, and add `ai-rulez generate --check` to CI. The
76
- [Quick start](https://goldziher.github.io/ai-rulez/quick-start/) walks through it in five minutes.
28
+ The package is a thin launcher for the `ai-rulez` Go binary. On the first run it downloads the binary for your platform
29
+ (Linux and macOS on amd64 and arm64, Windows on amd64) from the matching GitHub release, verifies its SHA-256 checksum,
30
+ and stores it inside the package. Later runs start it directly.
77
31
 
78
- <p align="center">
79
- <img src="https://raw.githubusercontent.com/Goldziher/ai-rulez/main/docs/assets/quickstart.gif" alt="ai-rulez init and generate: one .ai-rulez source becomes the native files of several AI tools" width="820" />
80
- </p>
81
-
82
- ## Install
32
+ ## Quickstart
83
33
 
84
34
  ```bash
85
- brew install goldziher/tap/ai-rulez # Homebrew (macOS, Linux)
86
- npm install -g ai-rulez # npm (Node.js 22+)
87
- pipx install ai-rulez # PyPI (Python 3.11+); or uv tool install ai-rulez
88
- go install github.com/Goldziher/ai-rulez/v5/cmd/ai-rulez@latest # Go (note the /v5)
89
- ```
90
-
91
- Or run it without installing: `npx ai-rulez@latest <command>` or `uvx ai-rulez <command>`. See
92
- [Installation](https://goldziher.github.io/ai-rulez/installation/) for platforms, shell completion and git hooks.
93
-
94
- ## Supported tools
95
-
96
- 52 built-in presets, one per assistant, CLI agent or IDE integration. Combine any of them in `presets = [...]`;
97
- [Supported harnesses](https://goldziher.github.io/ai-rulez/harnesses/) shows which rules, skills, agents, commands, MCP servers, hooks and permissions
98
- each one receives. A tool that is not listed can be added as a [custom preset](https://goldziher.github.io/ai-rulez/profiles/).
99
-
100
- <details>
101
- <summary><strong>All 52 built-in presets</strong></summary>
102
-
103
- | Preset | Tool |
104
- | ------ | ---- |
105
- | `aiassistant` | [JetBrains AI Assistant](https://www.jetbrains.com/help/ai-assistant/) |
106
- | `amp` | [Sourcegraph Amp](https://ampcode.com) |
107
- | `antigravity` | [Google Antigravity](https://antigravity.google/docs) |
108
- | `augment` | [Augment Code](https://docs.augmentcode.com) |
109
- | `baz` | [Baz](https://baz.ai/docs/agents/skills-and-instructions) |
110
- | `bob` | [IBM Bob](https://bob.ibm.com/docs) |
111
- | `claude` | [Claude Code](https://code.claude.com/docs) |
112
- | `cline` | [Cline](https://docs.cline.bot) |
113
- | `codebuddy` | [CodeBuddy Code](https://www.codebuddy.ai/docs/cli) |
114
- | `codebuff` | [Codebuff](https://www.codebuff.com/docs) |
115
- | `codewhale` | [Codewhale](https://github.com/codewhale-hq/Codewhale) |
116
- | `codex` | [OpenAI Codex](https://developers.openai.com/codex) |
117
- | `commandcode` | [Command Code](https://commandcode.ai/docs) |
118
- | `copilot` | [GitHub Copilot](https://docs.github.com/en/copilot) |
119
- | `copilot-cli` | [GitHub Copilot CLI](https://docs.github.com/en/copilot/how-tos/copilot-cli) |
120
- | `cortex` | [Snowflake Cortex Code](https://docs.snowflake.com/en/user-guide/cortex-code/extensibility) |
121
- | `crush` | [Crush](https://github.com/charmbracelet/crush) |
122
- | `cursor` | [Cursor](https://cursor.com/docs) |
123
- | `deepagents` | [Deep Agents Code](https://docs.langchain.com/oss/deepagents/code) |
124
- | `devin` | [Devin CLI](https://docs.devin.ai/cli) |
125
- | `dsh` | [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness) |
126
- | `factory` | [Factory Droid](https://docs.factory.ai) |
127
- | `gemini` | [Gemini CLI](https://geminicli.com/docs/) |
128
- | `gitlab-duo` | [GitLab Duo CLI](https://docs.gitlab.com/user/gitlab_duo_cli/customize/) |
129
- | `goose` | [goose](https://goose-docs.ai) |
130
- | `grok` | [Grok Build CLI](https://docs.x.ai/build/overview) |
131
- | `hermes` | [Hermes Agent](https://hermes-agent.nousresearch.com/docs) |
132
- | `junie` | [JetBrains Junie](https://junie.jetbrains.com) |
133
- | `kilo` | [Kilo Code](https://kilo.ai/docs) |
134
- | `kimi` | [Kimi Code](https://moonshotai.github.io/kimi-code/) |
135
- | `kiro` | [Kiro](https://kiro.dev/docs) |
136
- | `letta` | [Letta Code](https://docs.letta.com) |
137
- | `mimocode` | [MiMo Code](https://mimo.xiaomi.com/mimocode) |
138
- | `muse` | [Meta Muse Code](https://dev.meta.ai/docs/muse-code) |
139
- | `omp` | [oh-my-pi](https://github.com/can1357/oh-my-pi) |
140
- | `openclaw` | [OpenClaw](https://docs.openclaw.ai) |
141
- | `opencode` | [OpenCode](https://opencode.ai/docs) |
142
- | `pi` | [pi](https://pi.dev/docs/latest) |
143
- | `poolside` | [Poolside Pool](https://docs.poolside.ai) |
144
- | `qoder` | [Qoder](https://docs.qoder.com/cli/quickstart) |
145
- | `qwen` | [Qwen Code](https://qwenlm.github.io/qwen-code-docs/en/) |
146
- | `reasonix` | [Reasonix](https://github.com/esengine/DeepSeek-Reasonix) |
147
- | `replit` | [Replit Agent](https://docs.replit.com/features/agent/overview) |
148
- | `rovodev` | [Atlassian Rovo Dev](https://www.atlassian.com/software/rovo-dev) |
149
- | `takt` | [Takt](https://github.com/nrslib/takt) |
150
- | `trae` | [Trae](https://docs.trae.ai/ide/rules) |
151
- | `vibe` | [Mistral Vibe](https://docs.mistral.ai/vibe) |
152
- | `warp` | [Warp](https://docs.warp.dev) |
153
- | `xum` | [Xum](https://xum.coder.com) |
154
- | `zcode` | [ZCode](https://zcode.z.ai/en/docs) |
155
- | `zed` | [Zed](https://zed.dev/docs/ai) |
156
- | `zoocode` | [Zoo Code](https://docs.zoocode.dev) |
157
-
158
- </details>
159
-
160
- ## What else it does
161
-
162
- | Area | Commands | Docs |
163
- | ---- | -------- | ---- |
164
- | Author | `add`, `edit`, `show`, `list`, `remove`, `domain`, `profile`, `include`, `skill install` | [Configuration](https://goldziher.github.io/ai-rulez/configuration/), [Rules](https://goldziher.github.io/ai-rulez/rules/), [Skills](https://goldziher.github.io/ai-rulez/skills/), [Includes](https://goldziher.github.io/ai-rulez/includes/) |
165
- | Import | `init --from auto`, `convert`, `migrate v5` | [CLI](https://goldziher.github.io/ai-rulez/cli/), [Migrating to v5](https://goldziher.github.io/ai-rulez/migration-v5/) |
166
- | Generate | `generate`, `generate --user`, `generate --recursive`, `generate --watch`, `clean` | [Harnesses](https://goldziher.github.io/ai-rulez/harnesses/), [Hooks and settings](https://goldziher.github.io/ai-rulez/settings/), [Monorepo](https://goldziher.github.io/ai-rulez/monorepo/) |
167
- | Validate | `validate`, `scan`, `verifiers run`, `judge`, `review` | [Strict validation](https://goldziher.github.io/ai-rulez/strict-validation/), [Verifiers](https://goldziher.github.io/ai-rulez/verifiers/), [Judge](https://goldziher.github.io/ai-rulez/judge/) |
168
- | Govern | `lock`, `update`, `approve`, `sign`, `verify`, `sbom` | [Lock file](https://goldziher.github.io/ai-rulez/lockfile/), [Signing](https://goldziher.github.io/ai-rulez/signing/), [Policy](https://goldziher.github.io/ai-rulez/policy/) |
169
- | Bundle and publish | `generate --plugin`, `verify --plugin`, `publish` | [Plugins](https://goldziher.github.io/ai-rulez/plugins/), [Publish](https://goldziher.github.io/ai-rulez/publish/) |
170
- | Operate | `mcp --serve-skills`, `search`, `eval`, `tokens`, `cost`, `catalog`, `telemetry` | [MCP server](https://goldziher.github.io/ai-rulez/mcp-server/), [Evals](https://goldziher.github.io/ai-rulez/evals/) |
171
- | Embed | `pkg/airulez` | [Go API](https://goldziher.github.io/ai-rulez/embedding/) |
172
-
173
- `validate --strict` flags a defect, `--explain` describes it, and `generate --check` fails on drift:
35
+ ai-rulez init acme
36
+ ai-rulez add rule testing --content '# Testing
174
37
 
175
- <p align="center">
176
- <img src="https://raw.githubusercontent.com/Goldziher/ai-rulez/main/docs/assets/validate.gif" alt="ai-rulez validate --strict flags a defect, --explain describes it, and generate --check fails on drift" width="820" />
177
- </p>
178
-
179
- `verify --plugin` reports hand-edited or stray files in a plugin bundle, and `generate --plugin` restores it:
180
-
181
- <p align="center">
182
- <img src="https://raw.githubusercontent.com/Goldziher/ai-rulez/main/docs/assets/plugin-drift.gif" alt="ai-rulez verify --plugin reporting changed and extra files in a plugin bundle, then generate --plugin restoring it" width="820" />
183
- </p>
184
-
185
- Skills served over MCP cost no context until an assistant asks for them:
186
-
187
- <p align="center">
188
- <img src="https://raw.githubusercontent.com/Goldziher/ai-rulez/main/docs/assets/skills-mcp.gif" alt="ai-rulez tokens before and after serving skills over MCP, then find_skill and load_skill" width="780" />
189
- </p>
190
-
191
- In a monorepo, `generate --recursive` and `validate --recursive` process every nested `.ai-rulez/`:
192
-
193
- <p align="center">
194
- <img src="https://raw.githubusercontent.com/Goldziher/ai-rulez/main/docs/assets/monorepo.gif" alt="ai-rulez generate --recursive over two nested roots, recursive validation, and a token budget check" width="780" />
195
- </p>
196
-
197
- ## Standards
198
-
199
- ai-rulez generates and validates AGENTS.md, Agent Skills, Agent Plugins, ARD, llms.txt, OKF (the format of
200
- `.ai-rulez/` itself), MCP server configuration and Server Cards, CycloneDX and SPDX SBOMs, and in-toto/DSSE
201
- attestations in Sigstore bundles. [Standards conformance](https://goldziher.github.io/ai-rulez/standards/) lists the versions, the conformance tests
202
- and the known gaps.
203
-
204
- ## CI and git hooks
205
-
206
- GitHub Actions:
207
-
208
- ```yaml
209
- steps:
210
- - uses: actions/checkout@v7
211
- - uses: Goldziher/ai-rulez@v5
212
- with:
213
- version: 5.10.0
214
- - run: ai-rulez generate --check
215
- - run: ai-rulez validate
216
- ```
217
-
218
- See [GitHub Actions](https://goldziher.github.io/ai-rulez/github-actions/) for the full workflow and the governance gate.
219
-
220
- pre-commit or prek:
221
-
222
- ```yaml
223
- repos:
224
- - repo: https://github.com/Goldziher/ai-rulez
225
- rev: v5.11.0
226
- hooks:
227
- - id: ai-rulez-recursive
228
- - id: ai-rulez-validate
38
+ - Every bug fix ships with a regression test.'
39
+ ai-rulez generate
229
40
  ```
230
41
 
231
- See [GitHub Actions](https://goldziher.github.io/ai-rulez/github-actions/) for the governance gate and scheduled pin updates, and
232
- [Installation](https://goldziher.github.io/ai-rulez/installation/#git-hooks) for Lefthook, Poly and `init --setup-hooks`.
42
+ Set the tools you use in `.ai-rulez/config.toml` with `presets = ["claude", "cursor", "codex"]`. Run
43
+ `ai-rulez generate --check` in CI to catch drift. The
44
+ [Quick start](https://goldziher.github.io/ai-rulez/quick-start/) covers the rest.
233
45
 
234
- ## Upgrading from 4.x
46
+ ## Private registries and offline installs
235
47
 
236
- Run `ai-rulez migrate v5 --dry-run`, then follow [Migrating to v5](https://goldziher.github.io/ai-rulez/migration-v5/).
48
+ To avoid the GitHub download, publish the package with binaries in `bin/` named `ai-rulez-linux-amd64`,
49
+ `ai-rulez-linux-arm64`, `ai-rulez-darwin-amd64`, `ai-rulez-darwin-arm64` or `ai-rulez-windows-amd64.exe`. The launcher
50
+ uses a packaged binary first. If the Windows binary needs `liter_llm_ffi.dll`, add it as `bin/liter_llm_ffi.dll`.
237
51
 
238
- ## Documentation
52
+ ## Other channels
239
53
 
240
- Full documentation: [goldziher.github.io/ai-rulez](https://goldziher.github.io/ai-rulez/). Contributors: see
241
- [CONTRIBUTING.md](CONTRIBUTING.md) and [Architecture](https://goldziher.github.io/ai-rulez/architecture/).
54
+ Homebrew (`brew install goldziher/tap/ai-rulez`), PyPI (`pipx install ai-rulez` or `uv tool install ai-rulez`) and Go
55
+ (`go install github.com/Goldziher/ai-rulez/v5/cmd/ai-rulez@latest`). See
56
+ [Installation](https://goldziher.github.io/ai-rulez/installation/).
242
57
 
243
- ## License
58
+ ## Links
244
59
 
245
- [MIT](LICENSE)
60
+ [Documentation](https://goldziher.github.io/ai-rulez/) · [Source](https://github.com/Goldziher/ai-rulez) ·
61
+ [Issues](https://github.com/Goldziher/ai-rulez/issues) · [MIT license](https://github.com/Goldziher/ai-rulez/blob/main/LICENSE)
package/package.json CHANGED
@@ -1,66 +1,23 @@
1
1
  {
2
2
  "name": "ai-rulez",
3
- "version": "5.11.0",
4
- "description": "Author, generate, validate and govern AI agent rules, skills, plugins and MCP configuration across 52 coding assistants. Review with verified model evidence, evaluate skills, lock and sign dependencies, and publish bundles. CLI, MCP server and Go API.",
3
+ "version": "5.11.1",
4
+ "description": "Author, generate, validate and govern rules, skills, plugins and MCP configuration for 52 AI coding assistants from one .ai-rulez/ source. Lock, sign and SBOM your agent configuration, review it with verified model evidence, and publish plugin bundles. CLI, MCP server and Go API.",
5
5
  "keywords": [
6
- "agent-plugins",
7
- "agent-skills",
8
- "agents",
9
- "agents-md",
10
- "ai",
11
- "ai-assistant",
12
- "ai-development",
13
- "ai-governance",
14
6
  "ai-rules",
15
- "ard",
16
- "assistant-configuration",
17
- "automation",
18
- "baz",
19
- "claude",
7
+ "agents-md",
8
+ "agent-skills",
9
+ "agent-plugins",
20
10
  "claude-code",
21
- "cli",
22
- "cline",
23
- "code-generation",
24
- "code-review",
11
+ "cursor",
25
12
  "codex",
26
- "config",
27
- "configuration",
28
13
  "copilot",
29
- "cursor",
30
- "cyclonedx",
31
- "developer-tools",
32
- "development",
33
- "devin",
34
- "gemini",
35
- "generator",
36
- "git-hooks",
37
- "go",
38
- "golang",
39
- "governance",
40
- "hooks",
41
- "in-toto",
42
- "lifecycle",
43
- "llm-evaluation",
44
- "llms-txt",
45
14
  "mcp",
46
- "model-context-protocol",
47
- "monorepo",
48
- "okf",
49
- "opencode",
50
- "permissions",
51
- "pre-commit",
52
- "presets",
53
- "productivity",
54
- "publish",
55
- "rules",
15
+ "ai-governance",
56
16
  "sbom",
57
17
  "sigstore",
58
- "skills",
59
- "spdx",
60
- "standards",
61
18
  "supply-chain",
62
- "validation",
63
- "workflow"
19
+ "llms-txt",
20
+ "cli"
64
21
  ],
65
22
  "homepage": "https://goldziher.github.io/ai-rulez/",
66
23
  "bugs": {