dotruler 0.1.0__tar.gz

dotruler-0.1.0/.gitignore

@@ -0,0 +1,9 @@
+__pycache__/
+*.pyc
+*.egg-info/
+dist/
+build/
+.pytest_cache/
+.ruff_cache/
+*.egg
+.dotruler.toml

dotruler-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Joseph Yaw Agyeman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

dotruler-0.1.0/PKG-INFO

@@ -0,0 +1,193 @@
+Metadata-Version: 2.4
+Name: dotruler
+Version: 0.1.0
+Summary: One config. Every AI coding tool. Always in sync.
+Project-URL: Homepage, https://github.com/TRINITY-21/dotruler
+Project-URL: Repository, https://github.com/TRINITY-21/dotruler
+Project-URL: Issues, https://github.com/TRINITY-21/dotruler/issues
+Author: Joseph Yaw Agyeman
+License-Expression: MIT
+License-File: LICENSE
+Keywords: ai,claude,codex,config,copilot,cursor,rules,sync,windsurf
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.11
+Requires-Dist: typer[all]>=0.9.0
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <h1 align="center">dotruler</h1>
+  <p align="center">
+    <strong>One config. Every AI coding tool. Always in sync.</strong>
+  </p>
+  <p align="center">
+    <a href="https://pypi.org/project/dotruler/"><img src="https://img.shields.io/pypi/v/dotruler?color=blue" alt="PyPI"></a>
+    <a href="https://pypi.org/project/dotruler/"><img src="https://img.shields.io/pypi/pyversions/dotruler" alt="Python"></a>
+    <a href="https://github.com/TRINITY-21/dotruler/blob/main/LICENSE"><img src="https://img.shields.io/github/license/TRINITY-21/dotruler" alt="License"></a>
+  </p>
+</p>
+
+---
+
+Stop maintaining 6 separate config files. Define your project rules once in `.dotruler.toml` and generate configs for **Claude Code**, **Cursor**, **GitHub Copilot**, **Windsurf**, **OpenAI Codex**, and **Aider** — instantly.
+
+```bash
+pip install dotruler
+```
+
+## Overview
+
+Modern development workflows involve multiple AI coding assistants, each requiring its own instruction file:
+
+| AI Tool | Config File |
+|---------|------------|
+| Claude Code | `CLAUDE.md` |
+| Cursor | `.cursorrules` |
+| GitHub Copilot | `.github/copilot-instructions.md` |
+| Windsurf | `.windsurfrules` |
+| OpenAI Codex | `AGENTS.md` |
+| Aider | `CONVENTIONS.md` |
+
+These files inevitably drift out of sync — you update one, forget the rest, and your AI tools produce inconsistent results. **dotruler** solves this with a single source of truth.
+
+## How It Works
+
+```bash
+dotruler init          # Scan your project, scaffold .dotruler.toml
+vim .dotruler.toml     # Edit your single config
+dotruler generate      # Generate all target configs at once
+```
+
+## Getting Started
+
+### Installation
+
+```bash
+pip install dotruler
+```
+
+Requires Python 3.11+.
+
+### Initialize
+
+```bash
+cd your-project
+dotruler init
+```
+
+Automatically detects your languages, frameworks, package manager, and existing commands to scaffold a starter `.dotruler.toml`.
+
+### Configure
+
+```toml
+[project]
+name = "myapp"
+description = "Next.js web app with PostgreSQL"
+languages = ["typescript", "python"]
+frameworks = ["nextjs", "fastapi"]
+
+[style]
+rules = [
+  "Use functional components with hooks",
+  "Prefer const over let",
+  "Use TypeScript strict mode",
+]
+
+[commands]
+build = "npm run build"
+test = "pytest && npm test"
+lint = "ruff check . && npm run lint"
+dev = "npm run dev"
+
+[architecture]
+notes = [
+  "API routes in src/app/api/",
+  "Database models in src/models/",
+]
+
+[targets]
+enabled = ["claude-md", "cursorrules", "copilot"]
+```
+
+### Generate
+
+```bash
+dotruler generate
+```
+
+```
+Generating from .dotruler.toml...
+
+  ✓ CLAUDE.md
+  ✓ .cursorrules
+  ✓ .github/copilot-instructions.md
+
+Done. 3 configs generated.
+```
+
+## CLI Reference
+
+| Command | Description |
+|---------|-------------|
+| `dotruler init` | Scan project and create starter `.dotruler.toml` |
+| `dotruler generate` | Generate config files for all enabled targets |
+| `dotruler generate --dry-run` | Preview output without writing files |
+| `dotruler validate` | Check config for errors and warnings |
+| `dotruler diff` | Show what would change before writing |
+| `dotruler list` | Display all available output targets |
+
+## Supported Targets
+
+| Target | Output File | Char Limit |
+|--------|------------|------------|
+| `claude-md` | `CLAUDE.md` | — |
+| `cursorrules` | `.cursorrules` | — |
+| `copilot` | `.github/copilot-instructions.md` | — |
+| `windsurf` | `.windsurfrules` | 12,000 |
+| `codex` | `AGENTS.md` | 32,768 |
+| `aider` | `CONVENTIONS.md` | — |
+
+Character limits for Windsurf and Codex are automatically enforced during generation.
+
+## Per-Target Overrides
+
+Append tool-specific rules or customize output paths per target:
+
+```toml
+[targets]
+enabled = ["claude-md", "cursorrules", "copilot"]
+
+[targets.claude-md]
+extra_rules = ["Use Read tool before editing files"]
+output_path = "CLAUDE.md"
+
+[targets.cursorrules]
+extra_rules = ["Prefer .cursor/rules/*.mdc format"]
+```
+
+## Plugin Architecture
+
+All output targets are implemented as plugins using a registry pattern. The 6 built-in targets cover the major AI coding tools, but the system is designed for extensibility — adding a new target requires a single file with a decorated class.
+
+## Comparison
+
+| Approach | Limitation |
+|----------|-----------|
+| Manual copy-paste | Drifts within days |
+| Symlinks | Formats differ across tools |
+| [ruler](https://github.com/intellectronica/ruler) | Limited per-tool customization |
+| [rulesync](https://github.com/dyoshikawa/rulesync) | Requires Node.js |
+| [ai-rulez](https://github.com/Goldziher/ai-rulez) | Requires Go |
+
+**dotruler** is Python-native, TOML-configured, plugin-extensible, and validates your config before generating.
+
+## License
+
+[MIT](LICENSE)

dotruler-0.1.0/README.md

@@ -0,0 +1,169 @@
+<p align="center">
+  <h1 align="center">dotruler</h1>
+  <p align="center">
+    <strong>One config. Every AI coding tool. Always in sync.</strong>
+  </p>
+  <p align="center">
+    <a href="https://pypi.org/project/dotruler/"><img src="https://img.shields.io/pypi/v/dotruler?color=blue" alt="PyPI"></a>
+    <a href="https://pypi.org/project/dotruler/"><img src="https://img.shields.io/pypi/pyversions/dotruler" alt="Python"></a>
+    <a href="https://github.com/TRINITY-21/dotruler/blob/main/LICENSE"><img src="https://img.shields.io/github/license/TRINITY-21/dotruler" alt="License"></a>
+  </p>
+</p>
+
+---
+
+Stop maintaining 6 separate config files. Define your project rules once in `.dotruler.toml` and generate configs for **Claude Code**, **Cursor**, **GitHub Copilot**, **Windsurf**, **OpenAI Codex**, and **Aider** — instantly.
+
+```bash
+pip install dotruler
+```
+
+## Overview
+
+Modern development workflows involve multiple AI coding assistants, each requiring its own instruction file:
+
+| AI Tool | Config File |
+|---------|------------|
+| Claude Code | `CLAUDE.md` |
+| Cursor | `.cursorrules` |
+| GitHub Copilot | `.github/copilot-instructions.md` |
+| Windsurf | `.windsurfrules` |
+| OpenAI Codex | `AGENTS.md` |
+| Aider | `CONVENTIONS.md` |
+
+These files inevitably drift out of sync — you update one, forget the rest, and your AI tools produce inconsistent results. **dotruler** solves this with a single source of truth.
+
+## How It Works
+
+```bash
+dotruler init          # Scan your project, scaffold .dotruler.toml
+vim .dotruler.toml     # Edit your single config
+dotruler generate      # Generate all target configs at once
+```
+
+## Getting Started
+
+### Installation
+
+```bash
+pip install dotruler
+```
+
+Requires Python 3.11+.
+
+### Initialize
+
+```bash
+cd your-project
+dotruler init
+```
+
+Automatically detects your languages, frameworks, package manager, and existing commands to scaffold a starter `.dotruler.toml`.
+
+### Configure
+
+```toml
+[project]
+name = "myapp"
+description = "Next.js web app with PostgreSQL"
+languages = ["typescript", "python"]
+frameworks = ["nextjs", "fastapi"]
+
+[style]
+rules = [
+  "Use functional components with hooks",
+  "Prefer const over let",
+  "Use TypeScript strict mode",
+]
+
+[commands]
+build = "npm run build"
+test = "pytest && npm test"
+lint = "ruff check . && npm run lint"
+dev = "npm run dev"
+
+[architecture]
+notes = [
+  "API routes in src/app/api/",
+  "Database models in src/models/",
+]
+
+[targets]
+enabled = ["claude-md", "cursorrules", "copilot"]
+```
+
+### Generate
+
+```bash
+dotruler generate
+```
+
+```
+Generating from .dotruler.toml...
+
+  ✓ CLAUDE.md
+  ✓ .cursorrules
+  ✓ .github/copilot-instructions.md
+
+Done. 3 configs generated.
+```
+
+## CLI Reference
+
+| Command | Description |
+|---------|-------------|
+| `dotruler init` | Scan project and create starter `.dotruler.toml` |
+| `dotruler generate` | Generate config files for all enabled targets |
+| `dotruler generate --dry-run` | Preview output without writing files |
+| `dotruler validate` | Check config for errors and warnings |
+| `dotruler diff` | Show what would change before writing |
+| `dotruler list` | Display all available output targets |
+
+## Supported Targets
+
+| Target | Output File | Char Limit |
+|--------|------------|------------|
+| `claude-md` | `CLAUDE.md` | — |
+| `cursorrules` | `.cursorrules` | — |
+| `copilot` | `.github/copilot-instructions.md` | — |
+| `windsurf` | `.windsurfrules` | 12,000 |
+| `codex` | `AGENTS.md` | 32,768 |
+| `aider` | `CONVENTIONS.md` | — |
+
+Character limits for Windsurf and Codex are automatically enforced during generation.
+
+## Per-Target Overrides
+
+Append tool-specific rules or customize output paths per target:
+
+```toml
+[targets]
+enabled = ["claude-md", "cursorrules", "copilot"]
+
+[targets.claude-md]
+extra_rules = ["Use Read tool before editing files"]
+output_path = "CLAUDE.md"
+
+[targets.cursorrules]
+extra_rules = ["Prefer .cursor/rules/*.mdc format"]
+```
+
+## Plugin Architecture
+
+All output targets are implemented as plugins using a registry pattern. The 6 built-in targets cover the major AI coding tools, but the system is designed for extensibility — adding a new target requires a single file with a decorated class.
+
+## Comparison
+
+| Approach | Limitation |
+|----------|-----------|
+| Manual copy-paste | Drifts within days |
+| Symlinks | Formats differ across tools |
+| [ruler](https://github.com/intellectronica/ruler) | Limited per-tool customization |
+| [rulesync](https://github.com/dyoshikawa/rulesync) | Requires Node.js |
+| [ai-rulez](https://github.com/Goldziher/ai-rulez) | Requires Go |
+
+**dotruler** is Python-native, TOML-configured, plugin-extensible, and validates your config before generating.
+
+## License
+
+[MIT](LICENSE)

dotruler-0.1.0/pyproject.toml

@@ -0,0 +1,41 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "dotruler"
+version = "0.1.0"
+description = "One config. Every AI coding tool. Always in sync."
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.11"
+authors = [{ name = "Joseph Yaw Agyeman" }]
+keywords = ["ai", "rules", "claude", "cursor", "copilot", "windsurf", "codex", "config", "sync"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Code Generators",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "typer[all]>=0.9.0",
+]
+
+[project.scripts]
+dotruler = "dotruler.cli:app"
+
+[project.urls]
+Homepage = "https://github.com/TRINITY-21/dotruler"
+Repository = "https://github.com/TRINITY-21/dotruler"
+Issues = "https://github.com/TRINITY-21/dotruler/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/dotruler"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

dotruler-0.1.0/src/dotruler/__init__.py

@@ -0,0 +1,3 @@
+"""dotruler — One config. Every AI coding tool. Always in sync."""
+
+__version__ = "0.1.0"