rulesync
- Repo stars 0
- Author repo skills-registry
- Domain
- Other
- Author-declared agents
- No explicit declaration found; this is not inferred or tested compatibility
- Static check
- 88 / 100 · heuristic scan, not runtime safety proof
- Runtime evidence
- Not run; no isolated runtime test evidence is currently recorded
- Author / version / license
- @tomevault-io · no license declared
- Token usage
- Lean
- Setup complexity
- Plug-and-play
- External API key
- Not required
- Operating systems
- macOS · Linux · Windows
- Runtime requirements
- No explicit requirements detected
- Detected file/system behavior
-
- Read-only
- Write / modify
- Network behavior
- External requests
- Install commands
- None (reference only)
Heads up: Tool permissions are not declared; actual access depends on the runtime.
# Rulesync
Rulesync generates and synchronizes AI rule configuration files across 20+ coding tools (Claude Code, Cursor, Copilot, Windsurf, Cline, Gemini CLI, and more) from a single set of unified rule files in `.rulesync/`.
## Quick Start
```bash
# Install
npm install -g rulesync
# New project: initialize config, rules, and directory structure
rulesync init
# Import existing AI tool configs into unified format
rulesync import --targets claudecode # From CLAUDE.md
rulesync import --targets cursor # From .cursorrules
rulesync import --targets copilot # From .github/copilot-instructions.md
# Generate tool-specific configs from unified rules
rulesync generate --targets "*" --features "*"
```
## Core Workflow
1. **Init** - `rulesync init` creates `rulesync.jsonc` config and `.rulesync/` directory with sample rules
2. **Write rules** - Add shared AI rules in `.rulesync/rules/`, MCP configs in `.rulesync/mcp/`, commands in `.rulesync/commands/`
3. **Generate** - `rulesync generate` produces tool-specific files (CLAUDE.md, .cursorrules, .github/copilot-instructions.md, etc.)
4. **Verify** - `rulesync generate --dry-run` previews changes; `--check` validates files are up to date (useful in CI)
## Key Commands
| Command | Purpose |
| ------------------------------------------------ | ------------------------------------------------ |
| `rulesync init` | Scaffold project with config and sample rules |
| `rulesync generate --targets "*" --features "*"` | Generate all tool configs from unified rules |
| `rulesync import --targets <tool>` | Import existing tool config into unified format |
| `rulesync fetch owner/repo --features skills` | Fetch rules or skills from a remote repository |
| `rulesync install` | Install skill sources declared in rulesync.jsonc |
| `rulesync generate --check` | CI check that generated files are up to date |
| `rulesync generate --dry-run` | Preview changes without writing files |
## Detailed Reference
- [Installation](./installation.md), [Quick Start](./quick-start.md)
- [Why Rulesync?](./why-rulesync.md), [Configuration](./configuration.md), [Global Mode](./global-mode.md), [Simulated Features](./simulated-features.md), [Declarative Sources](./declarative-sources.md), [Official Skills](./official-skills.md), [Dry Run](./dry-run.md), [Case Studies](./case-studies.md)
- [Supported Tools](./supported-tools.md), [CLI Commands](./cli-commands.md), [File Formats](./file-formats.md), [MCP Server](./mcp-server.md)
- [Programmatic API](./programmatic-api.md)
- [FAQ](./faq.md)
---
> Source: [codekiln/beans](https://github.com/codekiln/beans) — distributed by [TomeVault](https://tomevault.io).
<!-- tomevault:4.0:skill_md:2026-05-23 -->
Sections and files
Listed in source order.
sections -> Quick Start → Core Workflow → Key Commands → Detailed Reference
terms -> Init · Write rules · Generate · Verify
files/cmd -> .rulesync/ · rulesync init · rulesync.jsonc · .rulesync/rules/ · .rulesync/mcp/ · .rulesync/commands/ · rulesync generate · rulesync generate --dry-run
body sha256 -> a8daa273ea85
Core Workflow
Init -
rulesync initcreatesrulesync.jsoncconfig and.rulesync/directory with sample rules Write rules - Add shared AI rules in.rulesync/rules/, MCP configs in.rulesync/mcp/, commands in.rulesync/commands/Generate -rulesync generateproduces tool-specific files (CLAUDE.md, .cursorrules, .github/copilot-instructions.md, etc.) Verify -rulesync generate --dry-runpreviews changes;--checkvalidates files are up to date (useful in CI)Key Commands
Command · Purpose
rulesync init· Scaffold project with config and sample rulesrulesync generate --targets "*" --features "*"· Generate all tool configs from unified rulesrulesync import --targets <tool>· Import existing tool config into unified formatrulesync fetch owner/repo --features skills· Fetch rules or skills from a remote repositoryDetailed Reference
Installation, Quick Start Why Rulesync?, Configuration, Global Mode, Simulated Features, Declarative Sources, Official Skills, Dry Run, Case Studies Supported Tools, CLI Commands, File Formats, MCP Server Programmatic API FAQ