BurntSushi / ripgrep

ripgrep recursively searches directories for a regex pattern while respecting your gitignore
The Unlicense
48.83k stars 2.01k forks source link

docs(install): add x-cmd method to install rg #2901

Closed lunrenyi closed 1 month ago

lunrenyi commented 1 month ago
BurntSushi commented 1 month ago

When adding new installation instructions, I either need to be familiar with the tool or it needs to be clearly trustworthy. The latter can be met by clear widespread adoption.

I looked into x-cmd and how it works is not clear to me. There are at least some yellow flags I see:

Because of those yellow flags, I'm not comfortable adding it ripgrep's installation instructions at this time.

BurntSushi commented 1 month ago

I do see that x-cmd was added as installation instructions to eza: https://github.com/eza-community/eza/pull/1153

But it's not clear if the eza folks did due diligence. cc @cafkafk

edwinjhlee commented 1 month ago

Hi ~ I am the author of x-cmd.

Thanks for your attention. And I admire your due diligence. I will add more documentations in the future.


We repackage the rg binary build, and the x-cmd pkg download the rg bianry from here: https://github.com/x-cmd-build/rg/releases

We have a metadata file for sha512sum checking about the integrity of package.

We also have the integreity check of x-cmd source code: https://www.x-cmd.com/start/integrity-guarantee

In China, we use npm to deliver the package because github is blocked.


X-CMD is not conmunity-driven. I have established a small full-time team to exclusively focus on its development. However, all of the source code are open for maximum transparency.


We not only provide rg package, we also provided an experimental shell wrapper for rg -- rg module.

This is the demo of x-cmd rg module: https://www.x-cmd.com/mod/rg

This is the code of x-cmd rg module: https://github.com/x-cmd/x-cmd/blob/main/mod/rg/lib/main


In the future, I plan to add more rg shell wrappers in rg module. It is so much fun, like we do it on jq: https://www.x-cmd.com/mod/jq


X-CMD is not well known to the public. But now we are progressing in China, mostly because Chinese is our first language, and we are not good at English communication.

We will fire an issue or pr later once we achieve clear widespread adoption.


Thank you for creating such a great tool.