Rulesync logo

Rulesync

CommunityPopular
dyoshikawa
rulesync

Generates and syncs AI rule configuration files (.cursorrules, CLAUDE.md, copilot-instructions.md) across 20+ coding tools from a single source. Use when syncing AI rules, running rulesync commands, importing or generating rule files, or managing shared AI coding configurations.

Overview

Publisherdyoshikawa
Repositoryrulesync
Skill namerulesync
Stars
1.4K
Forks
151
Bundled files
Instructions only
LicenseMIT
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • Self-contained

    Everything the model needs lives in the instructions — no extra files to sync.

  • Open source

    Published by dyoshikawa on GitHub. Read the source before you install it.

Installation

Install the Rulesync AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/dyoshikawa/rulesync.git /tmp/rulesync
mkdir -p .claude/skills
cp -r /tmp/rulesync/skills/rulesync .claude/skills/rulesync
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Rulesync in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Rulesync on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Rulesync is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

Rulesync

Rulesync generates and synchronizes AI rule configuration files across 20+ coding tools (Claude Code, Cursor, Copilot, 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

CommandPurpose
rulesync initScaffold 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/repoFetch skills from a remote repository
rulesync installInstall skill sources declared in rulesync.jsonc
rulesync generate --checkCI check that generated files are up to date
rulesync generate --dry-runPreview changes without writing files
rulesync generate --watchRegenerate whenever source files change
rulesync docs [document]Print bundled documentation
rulesync docs --search <text>Search the bundled documentation

Detailed Reference

The complete Rulesync documentation is bundled with the CLI. Consult it with rulesync docs before answering Rulesync-specific questions or performing unfamiliar Rulesync operations — it is the canonical detailed reference.

  • rulesync docs — list every available document identifier
  • rulesync docs <document> — print one document, e.g. rulesync docs faq or rulesync docs guide/configuration
  • rulesync docs --search <text> — ranked full-text search across the documentation, e.g. rulesync docs --search "global mode"

Useful starting points: getting-started/quick-start, guide/configuration, reference/cli-commands, reference/supported-tools, reference/file-formats, faq.

Frequently asked questions

What does the Rulesync AI skill do?

Generates and syncs AI rule configuration files (.cursorrules, CLAUDE.md, copilot-instructions.md) across 20+ coding tools from a single source. Use when syncing AI rules, running rulesync commands, importing or generating rule files, or managing shared AI coding configurations.

Why use Rulesync on TypingMind?

Because you install it once and use it with any model. Rulesync is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Rulesync in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/dyoshikawa/rulesync/tree/main/skills/rulesync. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Rulesync?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Rulesync?

As many as you like. As long as a model supports skills, you can use Rulesync with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Rulesync AI skill free?

Yes. It is published on GitHub by dyoshikawa under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇