Skip to main content

AI Workflow Rules Generator CLI

Generate structured, controlled AI-assisted development workflows for your projects.

CI Python 3.10+ License: MIT Ruff


The Problem

AI coding assistants generate code fast — but without project rules they create:

  • inconsistent coding styles
  • duplicated implementations
  • missing documentation
  • unclear architectural decisions
  • loss of project context between AI sessions

This CLI solves that by generating a controlled AI development environment tailored to your project.


What It Does

Run one command in your project:

ai-wrg-cli init

Answer a few questions about your stack and workflow. The tool generates:

Output Description
.cursor/rules/ Cursor IDE rules
.claude/instructions.md Claude Code instructions
.codex/instructions.md OpenAI Codex instructions
.agents/rules/ Google Antigravity / Gemini workspace rules
docs/ Documentation structure templates
.ai-workflow/config.yaml Reproducible workflow configuration

Installation

Requirements: Python 3.10+

Recommended (Global CLI tool using pipx):

pipx install ai-wrg-cli

Standard pip:

pip install ai-wrg-cli

From source (for development):

git clone https://github.com/karen6630/ai-wrg-cli.git
cd ai-wrg-cli
pip install -e ".[dev]"

Quick Start

# Initialize AI workflow in your project
ai-wrg-cli init

# Skip wizard and use defaults (great for CI or quick testing)
ai-wrg-cli init --non-interactive

# Generate into a specific directory
ai-wrg-cli init --output ./my-project

# List all available modules
ai-wrg-cli modules

# Check installation health
ai-wrg-cli doctor

Available Modules

Modules are combined to create your workflow. Run ai-wrg-cli modules to see all:

Category Module Description
core core Base AI workflow rules
stack python Python development standards
stack laravel Laravel / PHP standards
stack node Node.js standards
stack php Generic PHP standards
workflow solo Solo developer workflow
workflow team Team development workflow
workflow ai-first AI-first development approach
quality standard Standard quality gates
quality strict Strict quality + type checking
tool docker Docker standards

How It Works

User Input (wizard or --non-interactive)
    │
    ▼
Configuration Model  (.ai-workflow/config.yaml)
    │
    ▼
Module Resolution    (dependency + conflict checks)
    │
    ▼
Generator Pipeline   (Cursor / Claude / Codex / Docs)
    │
    ▼
Generated Project Files

The internal configuration is the source of truth — generated files are always reproducible.


Project Structure

src/ai_rules/
├── cli/          # Typer commands + interactive wizard
├── core/         # Config model, generator pipeline, module resolver
├── generators/   # AI tool generators (cursor, claude, codex, docs)
├── modules/      # Module loader, registry
└── templates/    # Jinja2 templates

modules/          # Built-in modules (YAML metadata + rules.md)
├── core/
├── stacks/       # python, laravel, node, php
├── workflow/     # solo, team, ai-first
├── quality/      # standard, strict
└── tools/        # docker

Adding a Custom Module

Create modules/stacks/my-stack/module.yaml:

name: my-stack
version: 1.0
category: stack
priority: 20
description: My custom stack rules
requires: []
conflicts: []

Add modules/stacks/my-stack/rules.md with your rules, then:

ai-wrg-cli modules      # verify it appears
ai-wrg-cli init         # select it in wizard

Contributing

See CONTRIBUTING.md for setup, architecture overview, and contribution guidelines.

Maintainers: PyPI release — docs/development/release-pypi.md (canonical; also in AGENTS.md and .cursor/rules/).


License

MIT

Download files

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

Source Distribution

ai_wrg_cli-0.1.6.tar.gz (35.1 kB view details)

Uploaded Source

Built Distribution

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

ai_wrg_cli-0.1.6-py3-none-any.whl (35.7 kB view details)

Uploaded Python 3

File details

Details for the file ai_wrg_cli-0.1.6.tar.gz.

File metadata

  • Download URL: ai_wrg_cli-0.1.6.tar.gz
  • Upload date:
  • Size: 35.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.2

File hashes

Hashes for ai_wrg_cli-0.1.6.tar.gz
Algorithm Hash digest
SHA256 fb02cf571e67f0a0556fef7dc05c3c1e09fb4b83168ab54171254180fc2e8554
MD5 dca527febf9eb02b6e2fc6c7928c55ab
BLAKE2b-256 86b6a690d9e0a91576293854f339ca2f1529f51cbb7947bbc796bf1a53b19b0e

See more details on using hashes here.

File details

Details for the file ai_wrg_cli-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: ai_wrg_cli-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 35.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.2

File hashes

Hashes for ai_wrg_cli-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 2f68f0d0ebc58e5175c8a028d13f923c4692df13cba0a3d97d38f240113f6c6b
MD5 d7be1061ff951f5b3cd50cac5710d19a
BLAKE2b-256 5eb428edc909bb584b9785def68163b418a0c9fb00dead1c17401c6d99994403

See more details on using hashes here.

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