ai-rulez 5.4.0 → 5.5.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 +17 -5
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -60,6 +60,7 @@ The table covers the implemented capabilities. The [CLI reference](docs/cli-refe
60
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
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
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
+ | Remote-session setup | A `SessionStart` hook (on by default for Claude Code) that runs `ai-rulez generate` when a cloud session starts. | `[session_start]`, `session-start` | [Remote sessions](docs/session-start.md) |
63
64
  | 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
65
  | 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
66
  | 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) |
@@ -408,7 +409,7 @@ Add to `.pre-commit-config.yaml`:
408
409
  ```yaml
409
410
  repos:
410
411
  - repo: https://github.com/Goldziher/ai-rulez
411
- rev: v5.4.0
412
+ rev: v5.5.0
412
413
  hooks:
413
414
  - id: ai-rulez-recursive # generate: write outputs for every nested .ai-rulez/ root
414
415
  - id: ai-rulez-validate # validate --recursive: content, security and link checks
@@ -439,7 +440,7 @@ repository needs:
439
440
  [[hooks.sources]]
440
441
  id = "ai-rulez"
441
442
  git = "https://github.com/Goldziher/ai-rulez.git"
442
- revision = "v5.4.0"
443
+ revision = "v5.5.0"
443
444
  hooks = ["ai-rulez-recursive", "ai-rulez-plugin-verify"]
444
445
  ```
445
446
 
@@ -492,9 +493,15 @@ the release's `checksums.txt`, caches it (keyed by OS, arch and the resolved ver
492
493
  toolchain, Node or Python needed in the job. It reuses the same `scripts/pre-commit/run-ai-rulez.sh`
493
494
  download-and-verify logic the pre-commit hooks above use, so the two stay in sync.
494
495
 
496
+ Use `Goldziher/ai-rulez@v5` for compatible action updates: publishing a stable v5 release advances
497
+ this floating tag after all distribution jobs succeed. Pin a full release tag or commit SHA to fix
498
+ the action code. The action ref and installed CLI version are independent: set `version` as well
499
+ to pin the binary; its default `latest` can eventually select a newer major release.
500
+
495
501
  | | |
496
502
  | --- | --- |
497
503
  | **Input** `version` | `X.Y.Z`, `vX.Y.Z`, or `latest` (default). Optional — omit it to always use the newest release. |
504
+ | **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). |
498
505
  | **Output** `version` | The resolved version, without the leading `v`. |
499
506
  | **Output** `path` | Absolute path to the installed `ai-rulez` binary. |
500
507
 
@@ -512,9 +519,9 @@ jobs:
512
519
  runs-on: ubuntu-latest
513
520
  steps:
514
521
  - uses: actions/checkout@v7
515
- - uses: Goldziher/ai-rulez@v5.4.0 # pin a release you reviewed
516
- # with:
517
- # version: 5.4.0 # optional; omit (or "latest") to always use the newest release
522
+ - uses: Goldziher/ai-rulez@v5
523
+ with:
524
+ version: 5.5.0 # pin the CLI independently of the floating action ref
518
525
  - run: ai-rulez generate --check # the committed output matches the sources
519
526
  - run: ai-rulez validate --strict # content and security checks, warnings fail
520
527
  - run: ai-rulez lock --check # pins were updated when the sources were
@@ -522,5 +529,10 @@ jobs:
522
529
 
523
530
  </details>
524
531
 
532
+ For model-backed reviews, configure `llm-model`, `llm-allow-network: 'true'` and spend limits,
533
+ pass provider credentials through `env:` on the command step or job, and run `ai-rulez judge
534
+ --allow-llm`. Installation itself makes no model requests. See the [action guide](docs/github-actions.md)
535
+ for all inputs, environment precedence, Bedrock, outputs and complete examples.
536
+
525
537
  See [CI usage](docs/lockfile.md#ci-usage) for the lock-check-vs-generate-check distinction and a scheduled
526
538
  "outdated sources" report job.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ai-rulez",
3
- "version": "5.4.0",
3
+ "version": "5.5.0",
4
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",