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.md Claude Code instructions
AGENTS.md Codex / OpenAI Codex instructions
docs/ Documentation structure templates
.ai-workflow/config.yaml Reproducible workflow configuration

Installation

Requirements: Python 3.10+

pip install ai-wrg-cli

Or install 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.


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.0.tar.gz (25.5 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.0-py3-none-any.whl (30.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ai_wrg_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 25.5 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.0.tar.gz
Algorithm Hash digest
SHA256 906cca401af9698ab24275ce27acb628309ea2dc55e74b6c1fb24e7ac524300c
MD5 0777aa1201a8534e424440e0a697702e
BLAKE2b-256 028f584daeb24b3ea7c9f15b4b775b42248b8a003e7c0fbb83225f3cd30ba788

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ai_wrg_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 30.4 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6e38c6ebce95371f229e4d0540143525754d26cb535ea631b404663ef657ab54
MD5 13d3974fdaf248f6a55aa18ffae23c9b
BLAKE2b-256 82df67f2322eacee786fbfcee8fce37b4c31721bc4ce60c40cd0b9e3ea6cfdaf

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