Skip to main content

Complete AI development workflow for 19+ tools. Ships with builtin rules, agents, and conventions. Generate native configs for Claude, Cursor, Copilot, Windsurf, Gemini, Codex and more from a single source.

Project description

AI-Rulez

ai-rulez

A complete development workflow for AI coding tools

Go Report Card npm version PyPI version License Documentation

Documentation · Quick Start · Examples


The Problem

Every AI coding tool wants its own config: Claude needs CLAUDE.md, Cursor wants .cursor/rules/, Copilot expects .github/copilot-instructions.md. Each has different formats, frontmatter, and directory conventions. If you use more than one tool, you're maintaining duplicate rules that inevitably drift apart.

The Solution

Write your rules, context, skills, agents, and commands once in .ai-rulez/. Run generate. Get native configs for every tool you use.

npx ai-rulez@latest init && npx ai-rulez@latest generate

ai-rulez generates correct, tool-native output for 19 platforms: Claude, Cursor, Windsurf, Copilot, Gemini, Cline, Continue.dev, Codex, OpenCode, Amp, Junie, Antigravity, and more. Each preset respects the target tool's conventions — proper frontmatter, directory structure, file extensions, agent formats.

What Ships Out of the Box

ai-rulez isn't just a config generator. It ships with 32 builtin domains containing opinionated rules, agents, and workflows that establish a professional development baseline immediately.

Builtin Rules (auto-included)

These activate automatically. No configuration needed.

Domain What it enforces
ai-governance No AI signatures in commits. Concise communication. Systematic debugging. Verification before claiming success. Critical review of subagent output.
code-quality Anti-patterns prevention. Complexity limits. Dead code removal. Error handling standards. Readability.
testing TDD workflow (red-green-refactor, no exceptions). Testing anti-patterns. Meaningful assertions. Test independence.
git-workflow Atomic commits. Conventional commit messages. Safe operations. Branch hygiene.
security Secrets handling. Input validation. Dependency auditing. Least privilege.
token-efficiency Task runner usage. Incremental approach. Context preservation. Batch operations.
agent-delegation Multi-agent coordination and delegation patterns.

Builtin Agents

Specialized agents ready to use as subagents:

Agent Domain Model What it does
code-reviewer ai-governance sonnet Reviews changes for correctness, security, and conventions. Reports by severity.
test-writer testing sonnet Writes tests following strict TDD. Fails first, then implements.
security-auditor security sonnet Audits dependencies, scans for CVEs, reviews input validation.
docs-writer ai-governance haiku Writes clear, concise documentation. No fluff.
devops-engineer cicd haiku CI/CD pipelines, GitHub Actions, Docker, deployment automation.
release-engineer cicd haiku Version management, changelogs, multi-registry publishing.

Opt-in Domains

Enable these based on your stack:

Languages (10): rust, python, typescript, go, java, ruby, php, elixir, csharp, r

Bindings (10): pyo3, napi-rs, magnus, ext-php-rs, rustler, wasm, jni-rs, extendr, cgo, vite-plus

Operational: cicd, docker, observability, documentation, default-commands

# .ai-rulez/config.toml
builtins = ["rust", "python", "pyo3", "cicd", "docker", "default-commands"]

Content Types

Type Purpose Example
Rules What AI must/must not do Security standards, coding conventions
Context What AI should know Architecture docs, domain knowledge
Skills Reusable prompts and workflows Deployment checklist, review protocol
Agents Specialized AI personas Code reviewer, performance engineer
Commands Slash commands across tools /review, /deploy, /test

Organization at Scale

ai-rulez scales from solo projects to large organizations:

Domains — Group content by feature, language, or team:

.ai-rulez/domains/backend/rules/
.ai-rulez/domains/frontend/rules/

Profiles — Generate different configs for different audiences:

[profiles]
backend = ["backend", "database"]
frontend = ["frontend", "ui"]

Remote Includes — Share rules across repositories:

[[includes]]
name = "company-standards"
source = "https://github.com/company/ai-rules.git"
merge_strategy = "local-override"

Installed Skills — Pull reusable skills from external repos:

[[installed_skills]]
name = "kreuzberg"
source = "https://github.com/kreuzberg-dev/kreuzberg"

MCP Server

ai-rulez includes a built-in MCP server with 35+ tools that lets AI assistants manage their own governance. Add rules, update context, generate configs — all programmatically.

[[mcp_servers]]
name = "ai-rulez"
command = "npx"
args = ["-y", "ai-rulez@latest", "mcp"]

Installation

# No install required
npx ai-rulez@latest <command>

# Or install globally
brew install goldziher/tap/ai-rulez  # macOS
npm install -g ai-rulez              # npm
pip install ai-rulez                 # pip
go install github.com/Goldziher/ai-rulez/cmd@latest  # Go

Documentation

Full documentation at goldziher.github.io/ai-rulez.

License

MIT

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ai_rulez-4.0.4.tar.gz (11.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ai_rulez-4.0.4-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file ai_rulez-4.0.4.tar.gz.

File metadata

  • Download URL: ai_rulez-4.0.4.tar.gz
  • Upload date:
  • Size: 11.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ai_rulez-4.0.4.tar.gz
Algorithm Hash digest
SHA256 6a633a2dc9655caf4407e5714e577b790549591dff82a5a0b638e5d675cf1834
MD5 98e8879144a48b9c6abcb34064926afa
BLAKE2b-256 60a140302250883b200d6315f1d918b441db296f5ad6b2bc0deee177a588f80c

See more details on using hashes here.

Provenance

The following attestation bundles were made for ai_rulez-4.0.4.tar.gz:

Publisher: publish.yaml on Goldziher/ai-rulez

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ai_rulez-4.0.4-py3-none-any.whl.

File metadata

  • Download URL: ai_rulez-4.0.4-py3-none-any.whl
  • Upload date:
  • Size: 8.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ai_rulez-4.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 53b06a6f5a51bd57d9f6fd0f98ed48aecd0d56213cb2473869d1cdd8e06eb283
MD5 6461e4df2f8c10a968ab773508f62a34
BLAKE2b-256 698edcbc722b4458af4346aae4758f645c181c0f8136448097c42b2f293b6971

See more details on using hashes here.

Provenance

The following attestation bundles were made for ai_rulez-4.0.4-py3-none-any.whl:

Publisher: publish.yaml on Goldziher/ai-rulez

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page