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:

On Windows, prefer a virtual environment so ai-wrg-cli is available without adding Python Scripts to PATH:

python -m venv .venv

# PowerShell
.\.venv\Scripts\Activate.ps1

# cmd
.\.venv\Scripts\activate.bat

# Git Bash
source .venv/Scripts/activate

pip install ai-wrg-cli
ai-wrg-cli --version

Without a venv, pip install --user may place the binary in %APPDATA%\Python\Python3x\Scripts, which often is not on PATH — then the command ai-wrg-cli will not be found until that folder is added to PATH or you use python -m / pipx instead.

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 Name Description
core core Base AI collaboration rules
stack python, php, node, django, fastapi, laravel Backend languages / frameworks
stack react, nextjs, vue Frontend
tool sql, postgres, mysql, mongodb Database
tool docker, kubernetes DevOps
workflow solo, team, ai-first Workflow styles
quality standard, strict Quality gates

init asks for stack in four layers: Backend → Frontend → Database → DevOps (multi-select each).


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/
│   ├── backend/    # python, php, node, django, fastapi, laravel
│   └── frontend/   # react, nextjs, vue
├── workflow/       # solo, team, ai-first
├── quality/        # standard, strict
└── tools/
    ├── database/   # sql, postgres, mysql, mongodb
    └── devops/     # docker, kubernetes

Adding a Custom Module

Create e.g. modules/stacks/backend/my-stack/module.yaml in your project root (or next to --output). The CLI loads built-in modules first, then overlays ./modules from the project directory so custom modules appear in ai-wrg-cli modules and the init stack wizard.

name: my-stack
version: "1.0"
category: stack
priority: 20
description: My custom stack rules
requires: []
conflicts: []
stack_layer: backend   # backend | frontend | database | devops
wizard_label: "My Stack"
wizard_default: false

Add rules.md with your rules, then:

ai-wrg-cli modules      # verify it appears
ai-wrg-cli init         # select it under the matching layer

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.2.3.tar.gz (71.6 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.2.3-py3-none-any.whl (75.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ai_wrg_cli-0.2.3.tar.gz
  • Upload date:
  • Size: 71.6 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.2.3.tar.gz
Algorithm Hash digest
SHA256 bd453b41970b558c5b2cb05df61bbef31b9cff6e9b54e54017aa9e63bcead005
MD5 c40bfbef6c940111a6ea7b4ebe66cc39
BLAKE2b-256 18aa508167675b4ebda9b198d3b756e00485646a61dbc349b02e9c243f3b5c67

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ai_wrg_cli-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 75.5 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.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ce7e9704a6158709bb51ff1833a596590e9d77e9c5e6ff32d193379d9808b496
MD5 3d6a8ad177e8290d1277599e1745881f
BLAKE2b-256 69fc4b3f21fb459d5baf5622b9dd0be5f56e8fd37ca2abbfe5b28e9d8aeb10b1

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