Skip to content
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.

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

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

Closed
wants to merge 1 commit into from

Conversation

lunrenyi
Copy link

  • Hi, x-cmd is a toolbox for Posix Shell, offering a lightweight package manager built using shell and awk. It helps you download rg release packages from the internet and extract them into a unified directory for management, without requiring root permissions.

  • I mean, can the installation method provided by x-cmd be added to the rg installation.md?The installation method for the x command.

    x env use rg
    # or
    x rg
  • We wrote a rg introduction article and a demo

@BurntSushi
Copy link
Owner

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:

  • There are no commit messages whatsoever.
  • PRs from outside contributors seem to be rejected.
  • I couldn't find the mechanism, either in the code or in the documentation, where by the tool downloads packages to install. Is it downloading from github? Building from source?
  • Reading through the docs, most prose is non-specific and somewhat vague. This doesn't inspire confidence.
  • After searching, I could not find anyone else using it.

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

@BurntSushi BurntSushi closed this Sep 25, 2024
@BurntSushi
Copy link
Owner

I do see that x-cmd was added as installation instructions to eza: eza-community/eza#1153

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

@edwinjhlee
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants