规则同步
- 作者仓库星标 0
- 作者仓库 skills-registry
- 领域
- 通用
- 作者声明的智能体
- 未找到明确声明;不据此推断已兼容或已测试
- 静态检查
- 88 / 100 · 启发式扫描,不代表运行安全
- 运行环境证据
- 未执行;当前没有隔离运行测试证据
- 作者 / 版本 / 许可证
- @tomevault-io · 未声明许可证
- 上下文用量评级
- 低消耗
- 接入复杂程度
- 即装即用
- 是否需要外部接口密钥
- 不需要
- 兼容的系统
- macOS · Linux · Windows
- 运行环境要求
- 未检出明确要求
- 检测到的文件与系统行为
-
- 只读
- 允许写入 / 修改
- 网络行为
- 允许外网请求
- 安装命令数
- 无(仅作为资料)
需要注意: 未声明工具权限范围;实际权限由运行环境决定。
# 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 "*"
# 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 -->
章节与文件索引
按说明文件中的顺序排列。
核心工作流程
按键命令
详细参考
文件/命令 -> .rulesync/ · rulesync init · rulesync.jsonc · .rulesync/rules/ · .rulesync/mcp/ · .rulesync/commands/ · rulesync generate · rulesync generate --dry-run
内容校验值 -> a8daa273ea85
当前原文的自动摘译,尚未人工审校。
核心工作流程
初始化 -
rulesync init使用示例规则创建rulesync.jsonc配置和.rulesync/目录 编写规则 - 在.rulesync/rules/中添加共享 AI 规则,在.rulesync/mcp/中添加 MCP 配置,在.rulesync/commands/中添加命令 生成 -rulesync generate生成特定于工具的文件(CLAUDE.md、.cursorrules、 .github/copilot-instructions.md 等)验证 -rulesync generate --dry-run预览更改;--check验证文件是否是最新的(在 CI 中有用)按键命令
命令 · 目的
rulesync init· 带有配置和示例规则的脚手架项目rulesync generate --targets "*" --features "*"· 从统一规则生成所有工具配置rulesync import --targets <tool>· 将现有工具配置导入到统一格式rulesync fetch owner/repo --features skills· 从远程存储库获取规则或技能详细参考
安装、快速入门 为什么要使用 Rulesync?、配置、全局模式、模拟功能、声明性来源、官方技能、试运行、案例研究 支持的工具、CLI 命令、文件格式、MCP 服务器编程 API 常见问题解答