rulesync 6.4.0 → 6.6.0

package/README.md

@@ -36,8 +36,19 @@ rulesync --help
 
 Download pre-built binaries from the [latest release](https://github.com/dyoshikawa/rulesync/releases/latest). These binaries are built using [Bun's single-file executable bundler](https://bun.sh/docs/bundler/executables).
 
+**Quick Install (Linux/macOS - No sudo required):**
+
+```bash
+curl -fsSL https://github.com/dyoshikawa/rulesync/releases/latest/download/install.sh | bash
+```
+
+Options:
+
+- Install specific version: `curl -fsSL https://github.com/dyoshikawa/rulesync/releases/latest/download/install.sh | bash -s -- v6.4.0`
+- Custom directory: `RULESYNC_HOME=~/.local curl -fsSL https://github.com/dyoshikawa/rulesync/releases/latest/download/install.sh | bash`
+
 <details>
-<summary>Commands to install a binary for your platform</summary>
+<summary>Manual installation (requires sudo)</summary>
 
 #### Linux (x64)
 
@@ -133,6 +144,7 @@ Rulesync supports both **generation** and **import** for All of the major AI cod
 | Tool               | rules | ignore |   mcp    | commands | subagents | skills | hooks |
 | ------------------ | :---: | :----: | :------: | :------: | :-------: | :----: | :---: |
 | AGENTS.md          |  ✅   |        |          |    🎮    |    🎮     |   🎮   |       |
+| AgentsSkills       |       |        |          |          |           |   ✅   |       |
 | Claude Code        | ✅ 🌏 |   ✅   | ✅ 🌏 📦 |  ✅ 🌏   |   ✅ 🌏   | ✅ 🌏  |  ✅   |
 | Codex CLI          | ✅ 🌏 |        |    🌏    |    🌏    |    🎮     | ✅ 🌏  |       |
 | Gemini CLI         | ✅ 🌏 |   ✅   |  ✅ 🌏   |  ✅ 🌏   |    🎮     |   🎮   |       |
@@ -201,6 +213,11 @@ npx rulesync init
 # Import existing configurations (to .rulesync/rules/ by default)
 npx rulesync import --targets claudecode --features rules,ignore,mcp,commands,subagents,skills
 
+# Fetch configurations from a Git repository
+npx rulesync fetch owner/repo
+npx rulesync fetch owner/repo@v1.0.0 --features rules,commands
+npx rulesync fetch https://github.com/owner/repo --conflict skip
+
 # Generate all features for all tools (new preferred syntax)
 npx rulesync generate --targets "*" --features "*"
 
@@ -214,8 +231,113 @@ npx rulesync generate --targets "*" --features rules
 # Generate simulated commands and subagents
 npx rulesync generate --targets copilot,cursor,codexcli --features commands,subagents --simulate-commands --simulate-subagents
 
+# Preview changes without writing files (dry-run mode)
+npx rulesync generate --dry-run --targets claudecode --features rules
+
+# Check if files are up to date (for CI/CD pipelines)
+npx rulesync generate --check --targets "*" --features "*"
+
 # Add generated files to .gitignore
 npx rulesync gitignore
+
+# Update rulesync to the latest version (single-binary installs)
+npx rulesync update
+
+# Check for updates without installing
+npx rulesync update --check
+
+# Force update even if already at latest version
+npx rulesync update --force
+```
+
+## Preview Modes
+
+Rulesync provides two preview modes for the `generate` command that allow you to see what changes would be made without actually writing files:
+
+### `--dry-run`
+
+Preview changes without writing any files. Shows what would be written or deleted with a `[PREVIEW]` prefix.
+
+```bash
+npx rulesync generate --dry-run --targets claudecode --features rules
+```
+
+### `--check`
+
+Same as `--dry-run`, but exits with code 1 if files are not up to date. This is useful for CI/CD pipelines to verify that generated files are committed.
+
+```bash
+# In your CI pipeline
+npx rulesync generate --check --targets "*" --features "*"
+echo $?  # 0 if up to date, 1 if changes needed
+```
+
+> [!NOTE]
+> `--dry-run` and `--check` cannot be used together.
+
+## Fetch Command (In Development)
+
+The `fetch` command allows you to fetch configuration files directly from a Git repository (GitHub/GitLab).
+
+> [!NOTE]
+> This feature is in development and may change in future releases.
+
+**Note:** The fetch command searches for feature directories (`rules/`, `commands/`, `skills/`, `subagents/`, etc.) directly at the specified path, without requiring a `.rulesync/` directory structure. This allows fetching from external repositories like `vercel-labs/agent-skills` or `anthropics/skills`.
+
+### Source Formats
+
+```bash
+# Full URL format
+npx rulesync fetch https://github.com/owner/repo
+npx rulesync fetch https://github.com/owner/repo/tree/branch
+npx rulesync fetch https://github.com/owner/repo/tree/branch/path/to/subdir
+npx rulesync fetch https://gitlab.com/owner/repo  # GitLab (planned)
+
+# Prefix format
+npx rulesync fetch github:owner/repo
+npx rulesync fetch gitlab:owner/repo              # GitLab (planned)
+
+# Shorthand format (defaults to GitHub)
+npx rulesync fetch owner/repo
+npx rulesync fetch owner/repo@ref        # Specify branch/tag/commit
+npx rulesync fetch owner/repo:path       # Specify subdirectory
+npx rulesync fetch owner/repo@ref:path   # Both ref and path
+```
+
+### Options
+
+| Option                  | Description                                                                                | Default                          |
+| ----------------------- | ------------------------------------------------------------------------------------------ | -------------------------------- |
+| `--target, -t <target>` | Target format to interpret files as (e.g., 'rulesync', 'claudecode')                       | `rulesync`                       |
+| `--features <features>` | Comma-separated features to fetch (rules, commands, subagents, skills, ignore, mcp, hooks) | `*` (all)                        |
+| `--output <dir>`        | Output directory relative to project root                                                  | `.rulesync`                      |
+| `--conflict <strategy>` | Conflict resolution: `overwrite` or `skip`                                                 | `overwrite`                      |
+| `--ref <ref>`           | Git ref (branch/tag/commit) to fetch from                                                  | Default branch                   |
+| `--path <path>`         | Subdirectory in the repository                                                             | `.` (root)                       |
+| `--token <token>`       | Git provider token for private repositories                                                | `GITHUB_TOKEN` or `GH_TOKEN` env |
+
+### Examples
+
+```bash
+# Fetch skills from external repositories
+npx rulesync fetch vercel-labs/agent-skills --features skills
+npx rulesync fetch anthropics/skills --features skills
+
+# Fetch all features from a public repository
+npx rulesync fetch dyoshikawa/rulesync --path .rulesync
+
+# Fetch only rules and commands from a specific tag
+npx rulesync fetch owner/repo@v1.0.0 --features rules,commands
+
+# Fetch from a private repository (uses GITHUB_TOKEN env var)
+export GITHUB_TOKEN=ghp_xxxx
+npx rulesync fetch owner/private-repo
+
+# Preserve existing files (skip conflicts)
+npx rulesync fetch owner/repo --conflict skip
+
+# Fetch from a monorepo subdirectory
+npx rulesync fetch owner/repo:packages/my-package
 ```
 
 ## Configuration
@@ -248,7 +370,7 @@ Example:
   "targets": ["cursor", "claudecode", "geminicli", "opencode", "codexcli"],
 
   // Features to generate. You can specify "*" to generate all features.
-  "features": ["rules", "ignore", "mcp", "commands", "subagents"],
+  "features": ["rules", "ignore", "mcp", "commands", "subagents", "hooks"],
 
   // Base directories for generation.
   // Basically, you can specify a `["."]` only.
@@ -628,7 +750,7 @@ Simulated commands, subagents and skills allow you to generate simulated feature
      Use the skill your-skill to achieve something.
      ```
 
-## Modular MCP (Experimental)
+## Modular MCP (Deprecated)
 
 Rulesync supports compressing tokens consumed by MCP servers [d-kimuson/modular-mcp](https://github.com/d-kimuson/modular-mcp) for context saving. When enabled with `--modular-mcp`, it additionally generates `modular-mcp.json`.
 
@@ -773,74 +895,22 @@ So, in this case, approximately 92% reduction in MCP tools consumption!
 
 </details>
 
-## Rulesync MCP Server
-
-Rulesync provides an MCP (Model Context Protocol) server that enables AI agents to manage your Rulesync files. This allows AI agents to discover, read, create, update, and delete files dynamically.
-
-> [!NOTE]
-> The MCP server exposes the only one tool to minimize your agent's token usage. Approximately less than 1k tokens for the tool definition.
-
-### Available Tools
-
-The Rulesync MCP server provides the following tools:
-
-<details>
-<summary>Rules Management</summary>
-
-- `list` - List all rule files
-- `get` - Get a specific rule file
-- `put` - Create or update a rule file
-- `delete` - Delete a rule file
-
-</details>
-
-<details>
-<summary>Commands Management</summary>
+## Official Skills
 
-- `list` - List all command files
-- `get` - Get a specific command file
-- `put` - Create or update a command file
-- `delete` - Delete a command file
-
-</details>
+Rulesync provides official skills that you can install using the fetch command:
 
-<details>
-<summary>Subagents Management</summary>
-
-- `list` - List all subagent files
-- `get` - Get a specific subagent file
-- `put` - Create or update a subagent file
-- `delete` - Delete a subagent file
-
-</details>
-
-<details>
-<summary>Skills Management</summary>
-
-- `list` - List all skill directories
-- `get` - Get a specific skill (SKILL.md and other files)
-- `put` - Create or update a skill directory
-- `delete` - Delete a skill directory
-
-</details>
-
-<details>
-<summary>Ignore Files Management</summary>
+```bash
+npx rulesync fetch dyoshikawa/rulesync --features skills
+```
 
-- `getIgnoreFile` - Get the ignore file
-- `putIgnoreFile` - Create or update the ignore file
-- `deleteIgnoreFile` - Delete the ignore file
+This will install the Rulesync documentation skill to your project.
 
-</details>
-
-<details>
-<summary>MCP Configuration Management</summary>
+## Rulesync MCP Server
 
-- `getMcpFile` - Get the MCP configuration file
-- `putMcpFile` - Create or update the MCP configuration file
-- `deleteMcpFile` - Delete the MCP configuration file
+Rulesync provides an MCP (Model Context Protocol) server that enables AI agents to manage your Rulesync files. This allows AI agents to discover, read, create, update, and delete files dynamically.
 
-</details>
+> [!NOTE]
+> The MCP server exposes the only one tool to minimize your agent's token usage. Approximately less than 1k tokens for the tool definition.
 
 ### Usage