ai-rulez 5.2.1 → 5.3.0

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 +14 -8
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -45,10 +45,10 @@ repository can loosen.
45
45
 
46
46
  | Stage | What happens | Commands | Docs |
47
47
  | ----- | ------------ | -------- | ---- |
48
- | **Author** | Rules, context, skills, agents, commands and checks as markdown in `.ai-rulez/`, with domains, profiles, roles and includes. `.ai-rulez/` is an [OKF](docs/okf.md) bundle: OKF is the internal format, and `init`, `add` and the MCP tools write it. A pre-OKF tree still loads, with a deprecation notice; `migrate okf` converts it. | `init`, `add`, `convert`, `import`, `migrate okf` | [Author](docs/configuration.md) |
48
+ | **Author** | Rules, context, skills, agents, commands and checks as markdown in `.ai-rulez/`, with domains, profiles, roles and includes. `.ai-rulez/` is an [OKF](docs/okf.md) bundle: OKF is the internal format, and `init`, `add` and the MCP tools write it. A pre-OKF tree still loads, with a deprecation notice; `migrate okf` converts it. Or keep `AGENTS.md` and `.agents/` as the source with `source = "agents"`: ai-rulez translates them to every other tool and never writes into them ([guide](docs/agents-source.md)). | `init`, `add`, `convert`, `import`, `migrate okf` | [Author](docs/configuration.md) |
49
49
  | **Generate** | Native files for 52 harnesses (Claude Code, Cursor, Codex, Copilot, Gemini CLI, OpenCode, Devin, Kilo and more), per project or per user. | `generate`, `doctor`, `clean` | [Harnesses](docs/harnesses.md) |
50
50
  | **Bundle** | Distributable plugin bundles, an Agent Plugins package, an OKF bundle, an ARD manifest, `AGENTS.md` and `llms.txt`. | `generate --plugin`, `export okf` | [Plugins](docs/plugins.md) |
51
- | **Lint and validate** | Content and security checks with stable `AR` codes, plus each standard's own schema or rules. | `validate`, `scan`, `okf validate`, `verify` | [Validate](docs/strict-validation.md) |
51
+ | **Lint and validate** | Content and security checks with stable `AR` codes, plus each standard's own schema or rules. Works in a repository with no ai-rulez config (`--path`, `--glob` and `--outputs` pick what to lint); `judge` grades instruction files with a model, also without config. | `validate`, `scan`, `judge`, `okf validate`, `verify` | [Validate](docs/strict-validation.md) |
52
52
  | **Govern** | A content-pinning lock, reviewer approvals, Sigstore signing, an organization policy and an SBOM. | `lock`, `approve`, `sign`, `verify --attestation`, `sbom` | [Trust model](docs/trust-model.md) |
53
53
  | **Publish** | Reproducible, checksummed release artifacts to GitHub releases, npm, OCI and marketplaces. | `publish` | [Publish](docs/publish.md) |
54
54
 
@@ -144,7 +144,7 @@ each row, and is the source of truth for test status.
144
144
  | [CycloneDX / SPDX SBOM](docs/sbom.md) | supported | `sbom` | `sbom --check` |
145
145
  | [in-toto / DSSE / Sigstore](docs/signing.md) | supported | `sign` | `verify --attestation` |
146
146
  | [OpenTelemetry (OTLP)](docs/telemetry.md) | supported | `telemetry export --to otlp` | not applicable |
147
- | "Agent bundle" | planned, no spec yet | none | none |
147
+ | "Agent bundle" | planned, no pinned spec | none | none |
148
148
 
149
149
  ## Usage
150
150
 
@@ -302,6 +302,9 @@ configured scope and plugin name for the released package.
302
302
  ai-rulez validate # config plus content checks, exit 2 on findings
303
303
  ai-rulez validate --explain AR001 # what a rule checks and how to suppress it
304
304
  ai-rulez validate --format sarif --output ai-rulez.sarif
305
+ ai-rulez validate --path catalog --glob "plugins/**/*.json" # also lint files outside .ai-rulez/
306
+ ai-rulez validate --outputs # also lint the generated files; each problem is reported once
307
+ ai-rulez validate --strict # in any repo: with no config it lints AGENTS.md, SKILL.md, .claude/, .agents/
305
308
  ai-rulez okf validate docs/okf # lint any OKF bundle, ai-rulez's or a third party's
306
309
  ai-rulez generate --check # generated files still match their sources
307
310
  ```
@@ -344,13 +347,16 @@ An organization [policy](docs/policy.md) sets tighten-only floors a repository c
344
347
  - **Telemetry.** Item-load records with an optional OTLP export. See [telemetry](docs/telemetry.md).
345
348
  - **Evals and improve.** `ai-rulez eval` scores skills; `improve` (experimental) optimizes them behind a held-out eval
346
349
  gate. See [evals](docs/evals.md) and [improve](docs/improve.md).
350
+ - **Judge.** `ai-rulez judge` grades `AGENTS.md` and `.agents/*` with a model from the command line alone, with no config
351
+ file: `ai-rulez judge --estimate --model openai/gpt-4o-mini`, then `--allow-llm` to send. See [judge](docs/judge.md).
347
352
  - **Cost and inventory.** `tokens`, `cost`, `catalog` and `search` report what the configuration contains and costs.
348
353
 
349
354
  Existing project on 4.x? Run `ai-rulez migrate v5 --dry-run`, then see [Migrating to v5](docs/migration-v5.md).
350
355
 
351
356
  ## Documentation
352
357
 
353
- Full documentation at [goldziher.github.io/ai-rulez](https://goldziher.github.io/ai-rulez/).
358
+ Full documentation at [goldziher.github.io/ai-rulez](https://goldziher.github.io/ai-rulez/). For how a source becomes
359
+ generated files, and the package map, see [Architecture](docs/architecture.md).
354
360
 
355
361
  ## Git Hooks
356
362
 
@@ -364,7 +370,7 @@ Add to `.pre-commit-config.yaml`:
364
370
  ```yaml
365
371
  repos:
366
372
  - repo: https://github.com/Goldziher/ai-rulez
367
- rev: v5.2.1
373
+ rev: v5.3.0
368
374
  hooks:
369
375
  - id: ai-rulez-recursive # generate: write outputs for every nested .ai-rulez/ root
370
376
  - id: ai-rulez-validate # validate --recursive: content, security and link checks
@@ -395,7 +401,7 @@ repository needs:
395
401
  [[hooks.sources]]
396
402
  id = "ai-rulez"
397
403
  git = "https://github.com/Goldziher/ai-rulez.git"
398
- revision = "v5.2.1"
404
+ revision = "v5.3.0"
399
405
  hooks = ["ai-rulez-recursive", "ai-rulez-plugin-verify"]
400
406
  ```
401
407
 
@@ -468,9 +474,9 @@ jobs:
468
474
  runs-on: ubuntu-latest
469
475
  steps:
470
476
  - uses: actions/checkout@v4
471
- - uses: Goldziher/ai-rulez@main # pin a release tag once one exists past v5.1.0 (the tag predates action.yml)
477
+ - uses: Goldziher/ai-rulez@v5.2.1 # a release tag from v5.2.0 on carries action.yml; pin the one you reviewed
472
478
  # with:
473
- # version: 5.1.0 # optional; omit (or "latest") to always use the newest release
479
+ # version: 5.2.1 # optional; omit (or "latest") to always use the newest release
474
480
  - run: ai-rulez generate --check # the committed output matches the sources
475
481
  - run: ai-rulez validate --strict # content and security checks, warnings fail
476
482
  - run: ai-rulez lock --check # pins were updated when the sources were
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ai-rulez",
3
- "version": "5.2.1",
3
+ "version": "5.3.0",
4
4
  "description": "Standards-compliant lifecycle tool for agent knowledge and capabilities. Author rules, skills, agents and MCP servers once; generate for 52 harnesses; bundle as OKF, Agent Plugins and ARD; validate against each standard; govern with signing, approvals and policy; publish.",
5
5
  "keywords": [
6
6
  "agent-plugins",