Skip to content

feat: Add rulesync fetch command to fetch configurations from GitHub #924

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dyoshikawa merged 5 commits into from
Feb 4, 2026
Merged

feat: Add rulesync fetch command to fetch configurations from GitHub #924

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f29be85
feat: Add rulesync fetch command to fetch configurations from GitHub
dyoshikawa Feb 4, 2026
dfd06d4
refactor: Improve fetch command code quality and security
dyoshikawa Feb 4, 2026
e198778
fix: Address code review and security review findings for fetch command
dyoshikawa Feb 4, 2026
ff004eb
refactor: Use URL API for building GitHub API URLs
dyoshikawa Feb 4, 2026
c6dc27c
refactor: Replace fetch API with @octokit/rest SDK
dyoshikawa Feb 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,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 GitHub 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 --dry-run

# Generate all features for all tools (new preferred syntax)
npx rulesync generate --targets "*" --features "*"

Expand All @@ -219,6 +224,60 @@ npx rulesync generate --targets copilot,cursor,codexcli --features commands,suba
npx rulesync gitignore
```

## Fetch Command

The `fetch` command allows you to fetch rulesync configuration files directly from a GitHub repository.

### Source Formats

```bash
# Full GitHub URL
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

# Shorthand format
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 |
| ----------------------- | ------------------------------------------------------------------------------------------ | -------------------------------- |
| `--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>` | GitHub token for private repositories | `GITHUB_TOKEN` or `GH_TOKEN` env |
| `--dry-run` | Preview changes without writing files | `false` |

### Examples

```bash
# Fetch all features from a public repository
npx rulesync fetch dyoshikawa/rulesync

# Fetch only rules and commands from a specific tag
npx rulesync fetch owner/repo@v1.0.0 --features rules,commands

# Preview what would be fetched without making changes
npx rulesync fetch owner/repo --dry-run

# 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

You can configure Rulesync by creating a `rulesync.jsonc` file in the root of your project.
Expand Down
2 changes: 2 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@
},
"dependencies": {
"@modelcontextprotocol/sdk": "1.25.3",
"@octokit/request-error": "7.1.0",
"@octokit/rest": "22.0.1",
"@toon-format/toon": "2.1.0",
"@valibot/to-json-schema": "1.5.0",
"commander": "14.0.2",
Expand Down
135 changes: 135 additions & 0 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading