Skip to main content

A universal CLI utility to configure AI rules files for any project.

Project description

airules

A universal CLI utility to configure AI rules files (e.g., .roo/rules, CLAUDE.md, .cursor/rules) for any project, based on the latest industry best practices via live Perplexity research.

Features

  • Supports any language or framework via --lang and --tags options
  • Configures rules for tools like Cursor, Roo, Claude, and more
  • Uses live Perplexity API for up-to-date best practices
  • Dry-run mode to preview changes
  • Prompts before overwriting existing files
  • Simple one-command install (packaged for PyPI)
  • Designed for future MCP integration

Quickstart

# Create and activate a virtual environment (required)
python3 -m venv .venv
source .venv/bin/activate

# Install dependencies
pip install -r requirements.txt

# Run the CLI (auto-detects project context if possible)
python -m airules.cli --lang python --tool cursor --tags langgraph,langchain,pytest

# Run tests
make test

Options

  • --lang <language>: Programming language (e.g., python, javascript)
  • --tool <tool>: Which rules file/tool to configure (e.g., cursor, roo, claude)
  • --tags <tag1,tag2,...>: Comma-separated list of frameworks/libraries
  • --dry-run: Show what would be changed without writing files
  • --yes, -y: Overwrite files without prompting
  • --project-path <path>: (Optional) Target project directory

Development

  • Code files are kept short and simple
  • Tests and >85% coverage are required
  • All lint and security issues must be fixed
  • ALWAYS use a virtual environment for all development and usage

This project is in early development. See CONTRIBUTING.md for guidelines.

Project details


Download files

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

Source Distribution

rules4-0.0.1.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

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

rules4-0.0.1-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file rules4-0.0.1.tar.gz.

File metadata

  • Download URL: rules4-0.0.1.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.11

File hashes

Hashes for rules4-0.0.1.tar.gz
Algorithm Hash digest
SHA256 ca1a1154c335906305d00c09f0aaf5d9c25996561e20811e57d20f1e7899ca78
MD5 59a19ac09f01be89e9f69c4548d23bbf
BLAKE2b-256 f66ab96757e18655f0f5ab50a0c4e1f1f2fcd89f4fe058702dea2b63a9d5b256

See more details on using hashes here.

File details

Details for the file rules4-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: rules4-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 7.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.11

File hashes

Hashes for rules4-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e0ab057d1ac97d84de9c13bfdc4a65548958e6e03f36f42d06730045f0ae8621
MD5 f7dcb61e2583fb6f3f24085c8f6e4a08
BLAKE2b-256 6ed1ebda1ca9701421e8bdc58c3e6e9aee8d63ea48e60becafdb09d7b7e37a9a

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