Skip to content

feature_request(docs): more examples of usage #2

@Kristinita

Description

@Kristinita

1. Summary

It would be nice if more examples of usage will be added to the documentation of the grab-github-release.

2. Justification

Using grab-github-release may be not simple for users. I can’t set correct commands for my needs.

3. Details

For example, I want to get archives (certainly, correct for each OS) from the latest release of fd and from the release 5.4.0 of HTML Tidy, and then place binaries from these archives to the node_modules\.bin folder. I tried many times, but I can’t get expected behavior. Example command for my Windows:

D:\SashaDebugging\KiraFetchGitHubRelease>npx grab-github-release --arch-suffixes x64=pc-windows-gnu --name=fd-v10.2.0 --platform-suffixes win32=x86_64 --repository sharkdp/fd --target-dir node_modules/.bin --unpack-exe --verbose
fetch "https://api.github.com/repos/sharkdp/fd/releases" (authorized)
30 releases
match "10.2.0" (v10.2.0)
skip "fd-musl_10.2.0_amd64.deb"
skip "fd-musl_10.2.0_arm64.deb"
skip "fd-musl_10.2.0_armhf.deb"
skip "fd-musl_10.2.0_i686.deb"
skip "fd-v10.2.0-aarch64-apple-darwin.tar.gz"
skip "fd-v10.2.0-aarch64-unknown-linux-gnu.tar.gz"
skip "fd-v10.2.0-aarch64-unknown-linux-musl.tar.gz"
skip "fd-v10.2.0-arm-unknown-linux-gnueabihf.tar.gz"
skip "fd-v10.2.0-arm-unknown-linux-musleabihf.tar.gz"
skip "fd-v10.2.0-i686-pc-windows-msvc.zip"
skip "fd-v10.2.0-i686-unknown-linux-gnu.tar.gz"
skip "fd-v10.2.0-i686-unknown-linux-musl.tar.gz"
skip "fd-v10.2.0-x86_64-apple-darwin.tar.gz"
match "fd-v10.2.0-x86_64-pc-windows-gnu.zip"
check "C:\Users\SashaChernykh\.cache\grabghr\sharkdp_fd\fd-v10.2.0-x86_64-pc-windows-gnu_10.2.0.zip"
fetch "https://github.com/sharkdp/fd/releases/download/v10.2.0/fd-v10.2.0-x86_64-pc-windows-gnu.zip" (authorized)
ensure "C:\Users\SashaChernykh\.cache\grabghr\sharkdp_fd"
copy "node_modules\.bin\fd-v10.2.0-x86_64-pc-windows-gnu.zip" to "C:\Users\SashaChernykh\.cache\grabghr\sharkdp_fd\fd-v10.2.0-x86_64-pc-windows-gnu_10.2.0.zip"
unpack "node_modules\.bin\fd-v10.2.0-x86_64-pc-windows-gnu.zip"
Warning: Detected unsettled top-level await at file:///D:/SashaDebugging/KiraFetchGitHubRelease/node_modules/grab-github-release/bin/grab-github-release.js:147
    await grab({
    ^

I think, it would be nice if grab-github-release developers will add to the documentation examples, which commands users needs for parsing GitHub releases from repositories like fd and HTML Tidy.

Thanks.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions