ai-rulez 5.3.0 → 5.4.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 +68 -19
- package/package.json +7 -5
package/README.md
CHANGED
|
@@ -43,14 +43,48 @@ repository can loosen.
|
|
|
43
43
|
- **Supply-chain-grade trust.** Sigstore signing, in-toto/DSSE attestations, CycloneDX/SPDX SBOMs and reviewer approvals, so "what prompt is actually running in production" has a verifiable answer.
|
|
44
44
|
- **Org-wide policy, not just repo config.** A central [policy](docs/policy.md) sets tighten-only floors; `verify` and CI gates enforce it everywhere.
|
|
45
45
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
|
52
|
-
|
|
|
53
|
-
|
|
|
46
|
+
## Features
|
|
47
|
+
|
|
48
|
+
The table covers the implemented capabilities. The [CLI reference](docs/cli-reference.md) lists every command and flag;
|
|
49
|
+
[standards](#standards) below distinguishes supported formats from partial integrations.
|
|
50
|
+
|
|
51
|
+
| Feature | What it does | Commands / configuration | Docs |
|
|
52
|
+
| ------- | ------------ | ------------------------ | ---- |
|
|
53
|
+
| Content authoring | Manage rules, context, skills with scripts and references, agents, commands and code-review checks. | `init`, `add`, `edit`, `show`, `list`, `remove` | [Configuration](docs/configuration.md), [Skills](docs/skills.md), [Checks](docs/checks.md) |
|
|
54
|
+
| Open-standard sources | Use `.ai-rulez/` as an OKF bundle, or author in `AGENTS.md` and `.agents/` without generation overwriting that source. Convert a pre-OKF content tree in place. | `source = "agents"`, `migrate okf`, `export okf`, `import okf`, `okf validate` | [OKF](docs/okf.md), [Agents source](docs/agents-source.md) |
|
|
55
|
+
| Domains, profiles and roles | Organize content by domain, select domains by profile, and compose roles that filter items and control skill modes. | `domain`, `profile`, `roles`, `--profile`, `--role` | [Domains and profiles](docs/domains.md), [Roles](docs/roles.md) |
|
|
56
|
+
| Configuration layers and local overrides | Merge named TOML layers, a developer's local overlay and user-level settings; inspect the effective local changes. | `config layers`, `local`, `config.<name>.toml`, `--no-local` | [Layers](docs/configuration.md#layered-configuration), [Local configuration](docs/local-overrides.md) |
|
|
57
|
+
| Shared includes and skill installation | Reuse local or Git content, choose merge precedence, install individual skills and load skill sources with pinned revisions or version ranges. | `include`, `skill install/list/remove/update`, `includes`, `installed_skills`, `skill_sources` | [Includes](docs/includes.md), [Installed skills](docs/installed-skills.md) |
|
|
58
|
+
| Builtin content | Select bundled domains and individual guidance items, or exclude items from a selected pack. | `builtins list/show`, `builtins` | [Builtin domains](docs/domains.md) |
|
|
59
|
+
| Import and migration | Convert existing harness files and supported third-party layouts with a lossiness report; migrate a 4.x configuration to v5. | `convert`, `migrate v5` | [Conversion](docs/cli.md#convert-command), [Migration](docs/migration-v5.md) |
|
|
60
|
+
| Native generation | Render the file layouts, frontmatter and settings of 52 built-in harnesses, including Claude Code, Cursor, Codex, Copilot and Gemini CLI. | `generate`, `presets` | [Harness matrix](docs/harnesses.md) |
|
|
61
|
+
| Custom presets | Define templates or provider-backed presets for an additional harness and its supported content and settings. | `presets` inline tables, provider specs | [Custom presets](docs/profiles.md), [Provider-backed presets](docs/configuration.md#provider-backed-presets-full-parity) |
|
|
62
|
+
| Hooks, permissions and MCP settings | Translate shared hooks, allow/deny rules and MCP server definitions to each harness's supported native settings; report unsupported translations. | `hooks`, `permissions`, `mcp_servers` | [Settings](docs/settings.md), [Permissions](docs/permissions.md) |
|
|
63
|
+
| Generated-file guard | Install a supported harness's PreToolUse hook to block agent edits to generated files. | `[guard] generated = true`, `guard` | [Guard](docs/cli.md#guard-command) |
|
|
64
|
+
| User scope and monorepos | Generate user-level assistant configuration, watch source changes, or process nested project roots with ordered reports. | `generate --user`, `generate --watch`, `generate/validate --recursive` | [User scope](docs/user-scope.md), [Monorepos](docs/monorepo.md) |
|
|
65
|
+
| Drift, cleanup and diagnostics | Preview a generation plan, detect output drift, remove generated files and diagnose configuration, locks, tools and MCP placeholders. | `generate --dry-run/--emit-plan/--check`, `clean`, `doctor` | [CLI reference](docs/cli.md), [Architecture](docs/architecture.md) |
|
|
66
|
+
| Plugin and marketplace authoring | Bundle runtime-specific plugins and marketplace indexes, including multi-plugin definitions, Agent Plugins and opt-in Pi packages. | `generate --plugin`, `plugin`, `plugins_authoring`, `marketplaces_authoring` | [Plugins](docs/plugins.md), [Agent Plugins](docs/agent-plugins.md) |
|
|
67
|
+
| Discovery and documentation formats | Generate `AGENTS.md` and `llms.txt`; emit ARD manifests and experimental MCP Server Cards. | `agents_md`, `llms-txt` preset, `publish --emit`, `publish emit` | [AGENTS.md](docs/agents-md.md), [llms.txt](docs/llms-txt.md), [ARD](docs/ard.md), [MCP Server Cards](docs/mcp-server-card.md) |
|
|
68
|
+
| Release artifacts and publishing | Build reproducible archives, manifests and checksums, optionally sign them, verify a dist directory and explicitly upload to GitHub releases, npm or OCI. | `publish`, `publish verify`, `--to`, `--execute --yes` | [Publishing](docs/publish.md) |
|
|
69
|
+
| Static validation and security scanning | Check config, content, scripts and conventional harness files with stable `AR` codes, without requiring an ai-rulez config. Scope by paths, globs or Git changes; use fixes, suppressions, baselines and JSON/SARIF reports. | `validate`, `scan`, `--strict`, `--path`, `--glob`, `--outputs`, `--changed` | [Validation and security rules](docs/strict-validation.md), [Harness traps](docs/harness-traps.md) |
|
|
70
|
+
| External scanners | Run configured scanner programs with explicit execution/egress controls and merge their findings into validation reports. | `lint.external`, `scanners list/doctor`, `validate/scan --external` | [Scanner integrations](docs/strict-validation.md) |
|
|
71
|
+
| Repository verifiers | Run declared deterministic checks, opt into command or LLM predicates, link checks to rules, test fixtures and calibrate model-backed checks. | `verifiers run/list/explain/test/calibrate/suggest`, `validate --verifiers` | [Verifiers](docs/verifiers.md) |
|
|
72
|
+
| Model-based judge | Review agent configuration for security, quality and governance with quoted evidence, an adjudicator, rubric skills, change-impact selection and explicit incomplete coverage. Estimate before sending; cap spend and emit JSON or SARIF. | `judge`, `--estimate`, `--allow-llm`, `--changed`, `--skill`, `--fail-on` | [Judge](docs/judge.md) |
|
|
73
|
+
| Rubric review and patch proposals | Score configured items offline or with a semantic model, calibrate a rubric's gate and propose verified patches for findings. | `review`, `review calibrate/explain/fix`, `rubric` | [Review](docs/review.md) |
|
|
74
|
+
| Skill evaluation | Run harness-neutral eval cases through adapters; measure pass rate, trigger precision/recall, ablation and cost; import scenarios and calibrate estimates. | `eval run/import/calibrate-estimate` | [Evals](docs/evals.md) |
|
|
75
|
+
| Skill improvement (experimental) | Run an external optimizer on a copy, gate candidates against held-out evals, inspect results, apply an accepted change or open an isolated PR. | `improve run/show/apply/pr/clean/adapters` | [Improve](docs/improve.md) |
|
|
76
|
+
| Locks and source updates | Pin remote sources, installed skills, authored content and outputs; check drift, inspect outdated sources and update version-range pins. | `lock`, `lock --check/--diff/--outdated`, `update`, `skill update` | [Lock file](docs/lockfile.md) |
|
|
77
|
+
| Organization policy | Apply central floors for sources, approvals, signatures, execution and model use that repository settings cannot loosen. | `--policy`, `AI_RULEZ_POLICY`, `validate --show-policy` | [Policy](docs/policy.md), [Trust model](docs/trust-model.md) |
|
|
78
|
+
| Reviewer approvals | Bind approvals to content digests, review diffs, revoke or deny content, enforce authorized reviewers and verify signed approvals. | `approve`, `verify --approvals` | [Approvals](docs/approvals.md) |
|
|
79
|
+
| Signatures and attestations | Sign locks, bundles, skills, SBOMs and policies; verify Sigstore bundles, in-toto/DSSE attestations and publisher provenance. | `sign`, `verify --attestation/--self/--plugin`, `trust update` | [Signing](docs/signing.md) |
|
|
80
|
+
| Software bills of materials | Inventory AI content, dependencies and MCP packages in CycloneDX 1.6 or SPDX 2.3; detect SBOM drift and enforce lock and pin gates. | `sbom`, `sbom --check -o <file>`, `--require-lock`, `--strict-pins`, `--type spdx-json` | [SBOM](docs/sbom.md) |
|
|
81
|
+
| MCP management and skill serving | Expose configuration tools and reports to assistants; serve skills and supporting resources on demand with role filters and session budgets. Select a read-only server or reuse a local daemon. | `mcp`, `--serve-skills`, `--read-only`, `--daemon` | [MCP server](docs/mcp-server.md) |
|
|
82
|
+
| Skill search | Rank skills lexically, by vectors or with hybrid embeddings, maintain the index, evaluate ranking and mine queries from usage. | `search`, `search index/status/mine`, `search --eval` | [Search](docs/search.md) |
|
|
83
|
+
| Catalog and inventory | Inspect item metadata, owners, roles, dependencies and lock status; join eval/usage results, compare catalogs and build a static catalog website. | `catalog`, `catalog diff`, `catalog --html` | [Catalog](docs/catalog.md) |
|
|
84
|
+
| Token and context budgets | Report generated prompt tokens, compare profiles and roles, identify costly content and gate always-loaded or on-demand budgets. | `tokens`, `cost`, `--budget`, `--on-demand-budget` | [Token reports](docs/cli.md#tokens-command), [Cost reports](docs/cli.md#cost-command) |
|
|
85
|
+
| Usage and item-load telemetry | Opt into identifier-only skill invocation, feedback and item-load records; report usage and optionally export item-load telemetry through OTLP. | `telemetry record/report/feedback/enable/export` | [Usage telemetry](docs/usage-telemetry.md), [Item loads and OTLP](docs/telemetry.md) |
|
|
86
|
+
| Shared model access | Route model calls through liter-llm, including AWS Bedrock credential refresh and OpenAI-compatible gateways, with network consent, budgets, authenticated caching and redacted diagnostics. | `[llm]`, `llm doctor`, `llm estimate` | [LLM access](docs/llm.md) |
|
|
87
|
+
| Automation and embedding | Use the composite GitHub Action, pre-commit/prek, Poly or Lefthook; call the experimental Go API to load, validate, plan/apply generation and manage locks. Shell completion and JSON schemas support other integrations. | [Action](action.yml), `init --setup-hooks`, `completion`, `pkg/airulez` | [Git hooks](#git-hooks), [GitHub Actions](#github-actions), [Go API](docs/embedding.md), [Schemas](docs/schema.md) |
|
|
54
88
|
|
|
55
89
|
<p align="center">
|
|
56
90
|
<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 four AI tools" width="820" />
|
|
@@ -126,8 +160,7 @@ full parity through a [custom provider-backed preset](docs/configuration.md#prov
|
|
|
126
160
|
|
|
127
161
|
## Standards
|
|
128
162
|
|
|
129
|
-
Generation isn't limited to harness files — ai-rulez aims to be compliant with the major emerging standards in the agentic ecosystem. A standard is
|
|
130
|
-
validates it today, and **planned** when it does not yet.
|
|
163
|
+
Generation isn't limited to harness files — ai-rulez aims to be compliant with the major emerging standards in the agentic ecosystem. A standard is listed when the code generates and validates it today.
|
|
131
164
|
[docs/standards.md](docs/standards.md) carries the pinned spec version, the conformance test suite and the known gaps for
|
|
132
165
|
each row, and is the source of truth for test status.
|
|
133
166
|
|
|
@@ -144,7 +177,6 @@ each row, and is the source of truth for test status.
|
|
|
144
177
|
| [CycloneDX / SPDX SBOM](docs/sbom.md) | supported | `sbom` | `sbom --check` |
|
|
145
178
|
| [in-toto / DSSE / Sigstore](docs/signing.md) | supported | `sign` | `verify --attestation` |
|
|
146
179
|
| [OpenTelemetry (OTLP)](docs/telemetry.md) | supported | `telemetry export --to otlp` | not applicable |
|
|
147
|
-
| "Agent bundle" | planned, no pinned spec | none | none |
|
|
148
180
|
|
|
149
181
|
## Usage
|
|
150
182
|
|
|
@@ -202,6 +234,8 @@ ai-rulez validate --strict
|
|
|
202
234
|
```
|
|
203
235
|
|
|
204
236
|
The module path needs `/v5`; without it `@latest` resolves to an old build.
|
|
237
|
+
This local build needs cgo, a C toolchain and the Go module cache at runtime.
|
|
238
|
+
For a statically linked build, use `task build` from a clone; see [source installation](docs/installation.md).
|
|
205
239
|
|
|
206
240
|
</details>
|
|
207
241
|
|
|
@@ -347,8 +381,12 @@ An organization [policy](docs/policy.md) sets tighten-only floors a repository c
|
|
|
347
381
|
- **Telemetry.** Item-load records with an optional OTLP export. See [telemetry](docs/telemetry.md).
|
|
348
382
|
- **Evals and improve.** `ai-rulez eval` scores skills; `improve` (experimental) optimizes them behind a held-out eval
|
|
349
383
|
gate. See [evals](docs/evals.md) and [improve](docs/improve.md).
|
|
350
|
-
- **Judge.** `ai-rulez judge`
|
|
351
|
-
|
|
384
|
+
- **Judge.** `ai-rulez judge` reviews skills, agents, commands, rules, `CLAUDE.md`, `AGENTS.md`, MCP and settings files
|
|
385
|
+
with models, from the command line alone: security, quality and governance reviewers, a verifier that checks quoted
|
|
386
|
+
evidence, an independent adjudicator, and scores computed in code. Failed rubric criteria without a verifiable quote
|
|
387
|
+
are reported separately as unit-level findings. Governance reads the rules and
|
|
388
|
+
`CLAUDE.md` files that apply to each unit, nested `.claude/` directories at any depth. `ai-rulez judge --estimate`, then
|
|
389
|
+
`--allow-llm` to send; `--changed=origin/main` for a pull request, `--format sarif` for code scanning. See [judge](docs/judge.md).
|
|
352
390
|
- **Cost and inventory.** `tokens`, `cost`, `catalog` and `search` report what the configuration contains and costs.
|
|
353
391
|
|
|
354
392
|
Existing project on 4.x? Run `ai-rulez migrate v5 --dry-run`, then see [Migrating to v5](docs/migration-v5.md).
|
|
@@ -370,7 +408,7 @@ Add to `.pre-commit-config.yaml`:
|
|
|
370
408
|
```yaml
|
|
371
409
|
repos:
|
|
372
410
|
- repo: https://github.com/Goldziher/ai-rulez
|
|
373
|
-
rev: v5.
|
|
411
|
+
rev: v5.4.1
|
|
374
412
|
hooks:
|
|
375
413
|
- id: ai-rulez-recursive # generate: write outputs for every nested .ai-rulez/ root
|
|
376
414
|
- id: ai-rulez-validate # validate --recursive: content, security and link checks
|
|
@@ -401,7 +439,7 @@ repository needs:
|
|
|
401
439
|
[[hooks.sources]]
|
|
402
440
|
id = "ai-rulez"
|
|
403
441
|
git = "https://github.com/Goldziher/ai-rulez.git"
|
|
404
|
-
revision = "v5.
|
|
442
|
+
revision = "v5.4.1"
|
|
405
443
|
hooks = ["ai-rulez-recursive", "ai-rulez-plugin-verify"]
|
|
406
444
|
```
|
|
407
445
|
|
|
@@ -454,9 +492,15 @@ the release's `checksums.txt`, caches it (keyed by OS, arch and the resolved ver
|
|
|
454
492
|
toolchain, Node or Python needed in the job. It reuses the same `scripts/pre-commit/run-ai-rulez.sh`
|
|
455
493
|
download-and-verify logic the pre-commit hooks above use, so the two stay in sync.
|
|
456
494
|
|
|
495
|
+
Use `Goldziher/ai-rulez@v5` for compatible action updates: publishing a stable v5 release advances
|
|
496
|
+
this floating tag after all distribution jobs succeed. Pin a full release tag or commit SHA to fix
|
|
497
|
+
the action code. The action ref and installed CLI version are independent: set `version` as well
|
|
498
|
+
to pin the binary; its default `latest` can eventually select a newer major release.
|
|
499
|
+
|
|
457
500
|
| | |
|
|
458
501
|
| --- | --- |
|
|
459
502
|
| **Input** `version` | `X.Y.Z`, `vX.Y.Z`, or `latest` (default). Optional — omit it to always use the newest release. |
|
|
503
|
+
| **Inputs** `llm-*` | Optional provider, model, gateway, credential variable name, network opt-in, budgets and other LLM settings exported to later steps. [Full reference](docs/github-actions.md#llm-configuration-inputs). |
|
|
460
504
|
| **Output** `version` | The resolved version, without the leading `v`. |
|
|
461
505
|
| **Output** `path` | Absolute path to the installed `ai-rulez` binary. |
|
|
462
506
|
|
|
@@ -473,10 +517,10 @@ jobs:
|
|
|
473
517
|
check:
|
|
474
518
|
runs-on: ubuntu-latest
|
|
475
519
|
steps:
|
|
476
|
-
- uses: actions/checkout@
|
|
477
|
-
- uses: Goldziher/ai-rulez@v5
|
|
478
|
-
|
|
479
|
-
|
|
520
|
+
- uses: actions/checkout@v7
|
|
521
|
+
- uses: Goldziher/ai-rulez@v5
|
|
522
|
+
with:
|
|
523
|
+
version: 5.4.1 # pin the CLI independently of the floating action ref
|
|
480
524
|
- run: ai-rulez generate --check # the committed output matches the sources
|
|
481
525
|
- run: ai-rulez validate --strict # content and security checks, warnings fail
|
|
482
526
|
- run: ai-rulez lock --check # pins were updated when the sources were
|
|
@@ -484,5 +528,10 @@ jobs:
|
|
|
484
528
|
|
|
485
529
|
</details>
|
|
486
530
|
|
|
531
|
+
For model-backed reviews, configure `llm-model`, `llm-allow-network: 'true'` and spend limits,
|
|
532
|
+
pass provider credentials through `env:` on the command step or job, and run `ai-rulez judge
|
|
533
|
+
--allow-llm`. Installation itself makes no model requests. See the [action guide](docs/github-actions.md)
|
|
534
|
+
for all inputs, environment precedence, Bedrock, outputs and complete examples.
|
|
535
|
+
|
|
487
536
|
See [CI usage](docs/lockfile.md#ci-usage) for the lock-check-vs-generate-check distinction and a scheduled
|
|
488
537
|
"outdated sources" report job.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "ai-rulez",
|
|
3
|
-
"version": "5.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "5.4.1",
|
|
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.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"agent-plugins",
|
|
7
7
|
"agent-skills",
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
"ai",
|
|
11
11
|
"ai-assistant",
|
|
12
12
|
"ai-development",
|
|
13
|
+
"ai-governance",
|
|
13
14
|
"ai-rules",
|
|
14
15
|
"ard",
|
|
15
16
|
"assistant-configuration",
|
|
@@ -39,6 +40,7 @@
|
|
|
39
40
|
"hooks",
|
|
40
41
|
"in-toto",
|
|
41
42
|
"lifecycle",
|
|
43
|
+
"llm-evaluation",
|
|
42
44
|
"llms-txt",
|
|
43
45
|
"mcp",
|
|
44
46
|
"model-context-protocol",
|
|
@@ -92,7 +94,8 @@
|
|
|
92
94
|
"ai-rulez.js",
|
|
93
95
|
"install.js",
|
|
94
96
|
"README.md",
|
|
95
|
-
"bin/ai-rulez-*"
|
|
97
|
+
"bin/ai-rulez-*",
|
|
98
|
+
"bin/liter_llm_ffi.dll"
|
|
96
99
|
],
|
|
97
100
|
"os": [
|
|
98
101
|
"darwin",
|
|
@@ -101,8 +104,7 @@
|
|
|
101
104
|
],
|
|
102
105
|
"cpu": [
|
|
103
106
|
"x64",
|
|
104
|
-
"arm64"
|
|
105
|
-
"ia32"
|
|
107
|
+
"arm64"
|
|
106
108
|
],
|
|
107
109
|
"engines": {
|
|
108
110
|
"node": ">=22.0.0"
|