Skip to content

feat: support custom mirror via RIPGREP_PREBUILT_BINARIES_MIRROR env #62

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
levivilet merged 2 commits into from
Oct 21, 2025
Merged

feat: support custom mirror via RIPGREP_PREBUILT_BINARIES_MIRROR env #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
31ffa35
feat: support custom mirror via RIPGREP_PREBUILT_BINARIES_MIRROR env …
fengmk2 Oct 13, 2025
73126a4
Merge branch 'main' into download-from-mirror
levivilet Oct 21, 2025
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
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,13 @@ const childProcess = spawn(rgPath, ['abc', '.'], {
})
```

## Environment Variables

- `RIPGREP_PREBUILT_BINARIES_MIRROR`: Specify a custom mirror URL for downloading ripgrep prebuilt binaries. This is useful for users in regions where GitHub releases are slow or inaccessible, or for organizations using internal mirrors.
- **Default**: `https://github.com/microsoft/ripgrep-prebuilt/releases/download`
- **Example**: `export RIPGREP_PREBUILT_BINARIES_MIRROR=https://your-mirror.com/ripgrep-prebuilt/releases/download`
- **Note**: The mirror URL should follow the same path structure as the official repository, with binaries available at `{mirror-url}/{version}/ripgrep-{version}-{target}`

## Credits

This project is very much based on https://github.com/microsoft/vscode-ripgrep by Microsoft.
3 changes: 2 additions & 1 deletion src/downloadRipGrep.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,8 @@ export const downloadRipGrep = async (overrideBinPath) => {
}
}
const target = getTarget()
const url = `https://github.com/${REPOSITORY}/releases/download/${VERSION}/ripgrep-${VERSION}-${target}`
const baseUrl = process.env.RIPGREP_PREBUILT_BINARIES_MIRROR || `https://github.com/${REPOSITORY}/releases/download`
const url = `${baseUrl}/${VERSION}/ripgrep-${VERSION}-${target}`
const downloadPath = `${xdgCache}/vscode-ripgrep/ripgrep-${VERSION}-${target}`
const binPath = overrideBinPath ?? BIN_PATH
if (!(await pathExists(downloadPath))) {
Expand Down