Skip to main content

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

Project description

rules4

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)
rules4 --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.2.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.2-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rules4-0.0.2.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.2.tar.gz
Algorithm Hash digest
SHA256 a9f644b10bdcc0afbcabf51b1a866ec55e6061eb496507f2f79527dec258f8ca
MD5 aebaa3e4109fc8478478c52af6a3dfd0
BLAKE2b-256 de184e8508097e0a1978f57a3a6167e387488ff6b515d3c631bd2898388e1a7c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rules4-0.0.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1860bde02a7f24604bc2968b4c3119f4e2cd3a93c2fa94440fd4f71bc200a610
MD5 25643ae33f66e43fa566dd3732e6f650
BLAKE2b-256 9807b34baa7fced9e06ee889ab40ccff481deecdfd7314d03176f7f908f310a9

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