Metadata-Version: 2.4
Name: ai-rulez
Version: 5.11.0
Summary: 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.
Home-page: https://github.com/Goldziher/ai-rulez
Author: Na'aman Hirschfeld
Author-email: nhirschfeld@gmail.com
License-Expression: MIT AND Apache-2.0 AND Unicode-3.0
Project-URL: Homepage, https://goldziher.github.io/ai-rulez/
Project-URL: Documentation, https://goldziher.github.io/ai-rulez/
Project-URL: Bug Reports, https://github.com/Goldziher/ai-rulez/issues
Project-URL: Source, https://github.com/Goldziher/ai-rulez
Project-URL: Changelog, https://github.com/Goldziher/ai-rulez/releases
Project-URL: Funding, https://github.com/sponsors/Goldziher
Keywords: ai,ai-assistant,ai-rules,claude,cursor,copilot,devin,baz,gemini,cline,mcp,model-context-protocol,cli,configuration,config,rules,generator,golang,go,development,developer-tools,automation,workflow,productivity,pre-commit,git-hooks,code-generation,ai-development,assistant-configuration,monorepo,presets,agents,claude-code,codex,opencode,hooks,permissions,skills,code-review,okf,agent-plugins,ard,agent-skills,agents-md,llms-txt,sbom,cyclonedx,spdx,sigstore,in-toto,supply-chain,governance,ai-governance,llm-evaluation,standards
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Code Generators
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Security
Classifier: Topic :: System :: Software Distribution
Classifier: Topic :: Software Development :: Pre-processors
Classifier: Topic :: Text Processing :: General
Classifier: Topic :: Utilities
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Go
Classifier: Operating System :: OS Independent
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: THIRD_PARTY_NOTICES.md
License-File: LICENSES/Apache-2.0.txt
License-File: LICENSES/MIT-npm-high-impact.txt
License-File: LICENSES/Unicode-3.0.txt
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license-file
Dynamic: license-expression
Dynamic: project-url
Dynamic: requires-python
Dynamic: summary

<p align="center">
  <img src="https://raw.githubusercontent.com/Goldziher/ai-rulez/main/docs/assets/ai-rulez-banner.png" alt="AI-Rulez" width="820" />
</p>

<p align="center">
  <strong>One source for the rules, skills and settings of every AI coding assistant</strong>
</p>

<p align="center">
  <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>
  <a href="https://pypi.org/project/ai-rulez/"><img src="https://img.shields.io/pypi/v/ai-rulez?color=blue" alt="PyPI version"></a>
  <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>
  <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>
  <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>
  <a href="https://goldziher.github.io/ai-rulez/"><img src="https://img.shields.io/badge/docs-ai--rulez-blue" alt="Documentation"></a>
</p>

<p align="center">
  <a href="https://goldziher.github.io/ai-rulez/"><strong>Documentation</strong></a> &middot;
  <a href="https://goldziher.github.io/ai-rulez/quick-start/"><strong>Quick Start</strong></a> &middot;
  <a href="https://goldziher.github.io/ai-rulez/examples/"><strong>Examples</strong></a>
</p>


---

## What it is

ai-rulez keeps the instructions for your AI coding assistants in one directory, `.ai-rulez/`: rules, context, skills,
agents, commands, hooks, permissions and MCP servers. From that source it generates the native files of each assistant
your team uses (`AGENTS.md`, `CLAUDE.md`, `.cursor/rules/`, `.github/instructions/`, skill folders, MCP and settings
files) for 52 tools, and keeps them in sync.

- **One source, every tool.** Edit `.ai-rulez/`, run `generate`, and Claude Code, Cursor, Codex, Copilot, Gemini CLI
  and the rest get the same guidance in their own format.
- **Checked in CI.** `generate --check` catches drift; `validate` lints content, links and security issues with stable
  `AR` rule codes, and also works on plain `AGENTS.md` and `SKILL.md` files with no configuration.
- **Governed like dependencies.** A lock file pins remote includes, installed skills and authored content; approvals,
  Sigstore signatures, SBOMs and an organization policy cover the rest.
- **Packaged for distribution.** Build plugin bundles and marketplaces, Agent Plugins and ARD manifests, and publish
  them.

## 30-second example

```bash
npx ai-rulez@latest init acme
```

Set the tools you use in `.ai-rulez/config.toml`:

```toml
version = "5.0"
name = "acme"
presets = ["claude", "cursor", "codex", "copilot", "gemini"]
```

Add a rule and generate:

```bash
npx ai-rulez@latest add rule testing --content '# Testing

- Every bug fix ships with a regression test.'
npx ai-rulez@latest generate
```

```text
AGENTS.md                # rules and context, read by Codex, Cursor, Copilot and Gemini CLI
CLAUDE.md                # imports @AGENTS.md for Claude Code
.agents/skills/          # skills
.claude/skills/
.gemini/settings.json    # points Gemini CLI at AGENTS.md
.mcp.json, .cursor/mcp.json, .vscode/mcp.json, .codex/config.toml
```

Commit `.ai-rulez/` with the generated files, and add `ai-rulez generate --check` to CI. The
[Quick start](https://goldziher.github.io/ai-rulez/quick-start/) walks through it in five minutes.

<p align="center">
  <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" />
</p>

## Install

```bash
brew install goldziher/tap/ai-rulez                                # Homebrew (macOS, Linux)
npm install -g ai-rulez                                            # npm (Node.js 22+)
pipx install ai-rulez                                              # PyPI (Python 3.11+); or uv tool install ai-rulez
go install github.com/Goldziher/ai-rulez/v5/cmd/ai-rulez@latest    # Go (note the /v5)
```

Or run it without installing: `npx ai-rulez@latest <command>` or `uvx ai-rulez <command>`. See
[Installation](https://goldziher.github.io/ai-rulez/installation/) for platforms, shell completion and git hooks.

## Supported tools

52 built-in presets, one per assistant, CLI agent or IDE integration. Combine any of them in `presets = [...]`;
[Supported harnesses](https://goldziher.github.io/ai-rulez/harnesses/) shows which rules, skills, agents, commands, MCP servers, hooks and permissions
each one receives. A tool that is not listed can be added as a [custom preset](https://goldziher.github.io/ai-rulez/profiles/).

<details>
<summary><strong>All 52 built-in presets</strong></summary>

| Preset | Tool |
| ------ | ---- |
| `aiassistant` | [JetBrains AI Assistant](https://www.jetbrains.com/help/ai-assistant/) |
| `amp` | [Sourcegraph Amp](https://ampcode.com) |
| `antigravity` | [Google Antigravity](https://antigravity.google/docs) |
| `augment` | [Augment Code](https://docs.augmentcode.com) |
| `baz` | [Baz](https://baz.ai/docs/agents/skills-and-instructions) |
| `bob` | [IBM Bob](https://bob.ibm.com/docs) |
| `claude` | [Claude Code](https://code.claude.com/docs) |
| `cline` | [Cline](https://docs.cline.bot) |
| `codebuddy` | [CodeBuddy Code](https://www.codebuddy.ai/docs/cli) |
| `codebuff` | [Codebuff](https://www.codebuff.com/docs) |
| `codewhale` | [Codewhale](https://github.com/codewhale-hq/Codewhale) |
| `codex` | [OpenAI Codex](https://developers.openai.com/codex) |
| `commandcode` | [Command Code](https://commandcode.ai/docs) |
| `copilot` | [GitHub Copilot](https://docs.github.com/en/copilot) |
| `copilot-cli` | [GitHub Copilot CLI](https://docs.github.com/en/copilot/how-tos/copilot-cli) |
| `cortex` | [Snowflake Cortex Code](https://docs.snowflake.com/en/user-guide/cortex-code/extensibility) |
| `crush` | [Crush](https://github.com/charmbracelet/crush) |
| `cursor` | [Cursor](https://cursor.com/docs) |
| `deepagents` | [Deep Agents Code](https://docs.langchain.com/oss/deepagents/code) |
| `devin` | [Devin CLI](https://docs.devin.ai/cli) |
| `dsh` | [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness) |
| `factory` | [Factory Droid](https://docs.factory.ai) |
| `gemini` | [Gemini CLI](https://geminicli.com/docs/) |
| `gitlab-duo` | [GitLab Duo CLI](https://docs.gitlab.com/user/gitlab_duo_cli/customize/) |
| `goose` | [goose](https://goose-docs.ai) |
| `grok` | [Grok Build CLI](https://docs.x.ai/build/overview) |
| `hermes` | [Hermes Agent](https://hermes-agent.nousresearch.com/docs) |
| `junie` | [JetBrains Junie](https://junie.jetbrains.com) |
| `kilo` | [Kilo Code](https://kilo.ai/docs) |
| `kimi` | [Kimi Code](https://moonshotai.github.io/kimi-code/) |
| `kiro` | [Kiro](https://kiro.dev/docs) |
| `letta` | [Letta Code](https://docs.letta.com) |
| `mimocode` | [MiMo Code](https://mimo.xiaomi.com/mimocode) |
| `muse` | [Meta Muse Code](https://dev.meta.ai/docs/muse-code) |
| `omp` | [oh-my-pi](https://github.com/can1357/oh-my-pi) |
| `openclaw` | [OpenClaw](https://docs.openclaw.ai) |
| `opencode` | [OpenCode](https://opencode.ai/docs) |
| `pi` | [pi](https://pi.dev/docs/latest) |
| `poolside` | [Poolside Pool](https://docs.poolside.ai) |
| `qoder` | [Qoder](https://docs.qoder.com/cli/quickstart) |
| `qwen` | [Qwen Code](https://qwenlm.github.io/qwen-code-docs/en/) |
| `reasonix` | [Reasonix](https://github.com/esengine/DeepSeek-Reasonix) |
| `replit` | [Replit Agent](https://docs.replit.com/features/agent/overview) |
| `rovodev` | [Atlassian Rovo Dev](https://www.atlassian.com/software/rovo-dev) |
| `takt` | [Takt](https://github.com/nrslib/takt) |
| `trae` | [Trae](https://docs.trae.ai/ide/rules) |
| `vibe` | [Mistral Vibe](https://docs.mistral.ai/vibe) |
| `warp` | [Warp](https://docs.warp.dev) |
| `xum` | [Xum](https://xum.coder.com) |
| `zcode` | [ZCode](https://zcode.z.ai/en/docs) |
| `zed` | [Zed](https://zed.dev/docs/ai) |
| `zoocode` | [Zoo Code](https://docs.zoocode.dev) |

</details>

## What else it does

| Area | Commands | Docs |
| ---- | -------- | ---- |
| 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/) |
| 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/) |
| 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/) |
| 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/) |
| 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/) |
| Bundle and publish | `generate --plugin`, `verify --plugin`, `publish` | [Plugins](https://goldziher.github.io/ai-rulez/plugins/), [Publish](https://goldziher.github.io/ai-rulez/publish/) |
| 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/) |
| Embed | `pkg/airulez` | [Go API](https://goldziher.github.io/ai-rulez/embedding/) |

`validate --strict` flags a defect, `--explain` describes it, and `generate --check` fails on drift:

<p align="center">
  <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" />
</p>

`verify --plugin` reports hand-edited or stray files in a plugin bundle, and `generate --plugin` restores it:

<p align="center">
  <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" />
</p>

Skills served over MCP cost no context until an assistant asks for them:

<p align="center">
  <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" />
</p>

In a monorepo, `generate --recursive` and `validate --recursive` process every nested `.ai-rulez/`:

<p align="center">
  <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" />
</p>

## Standards

ai-rulez generates and validates AGENTS.md, Agent Skills, Agent Plugins, ARD, llms.txt, OKF (the format of
`.ai-rulez/` itself), MCP server configuration and Server Cards, CycloneDX and SPDX SBOMs, and in-toto/DSSE
attestations in Sigstore bundles. [Standards conformance](https://goldziher.github.io/ai-rulez/standards/) lists the versions, the conformance tests
and the known gaps.

## CI and git hooks

GitHub Actions:

```yaml
steps:
  - uses: actions/checkout@v7
  - uses: Goldziher/ai-rulez@v5
    with:
      version: 5.10.0
  - run: ai-rulez generate --check
  - run: ai-rulez validate
```

See [GitHub Actions](https://goldziher.github.io/ai-rulez/github-actions/) for the full workflow and the governance gate.

pre-commit or prek:

```yaml
repos:
  - repo: https://github.com/Goldziher/ai-rulez
    rev: v5.11.0
    hooks:
      - id: ai-rulez-recursive
      - id: ai-rulez-validate
```

See [GitHub Actions](https://goldziher.github.io/ai-rulez/github-actions/) for the governance gate and scheduled pin updates, and
[Installation](https://goldziher.github.io/ai-rulez/installation/#git-hooks) for Lefthook, Poly and `init --setup-hooks`.

## Upgrading from 4.x

Run `ai-rulez migrate v5 --dry-run`, then follow [Migrating to v5](https://goldziher.github.io/ai-rulez/migration-v5/).

## Documentation

Full documentation: [goldziher.github.io/ai-rulez](https://goldziher.github.io/ai-rulez/). Contributors: see
[CONTRIBUTING.md](CONTRIBUTING.md) and [Architecture](https://goldziher.github.io/ai-rulez/architecture/).

## License

[MIT](LICENSE)
