Github release installer
gh-release-install is a CLI helper to install Github releases on your system. It can be used for pretty much anything, to install a formatter in your CI, deploy some binary using an orcherstration tool, or on your desktop.
This project was mainly created to...
# ...turn this mess:
wget --quiet --output-document=- "https://github.com/koalaman/shellcheck/releases/download/v0.7.1/shellcheck-v0.7.1.linux.x86_64.tar.xz" \
| tar --extract --xz --directory=/usr/local/bin --strip-components=1 --wildcards 'shellcheck*/shellcheck' \
&& chmod +x /usr/local/bin/shellcheck
wget --quiet --output-document=/usr/local/bin/shfmt "https://github.com/mvdan/sh/releases/download/v3.2.1/shfmt_v3.2.1_linux_amd64" \
&& chmod +x /usr/local/bin/shfmt
# Into this:
pip3 install gh-release-install
gh-release-install \
"koalaman/shellcheck" \
"shellcheck-{tag}.linux.x86_64.tar.xz" --extract "shellcheck-{tag}/shellcheck" \
"/usr/bin/shellcheck"
gh-release-install \
"mvdan/sh" \
"shfmt_{tag}_linux_amd64" \
"/usr/bin/shfmt"
Features:
- Download releases from Github.
- Extract zip or tarball on the fly.
- Pin to a desired version or get the
latestversion. - Keep track of the local tools version using a version file.
Installation
Install the package from pip:
pip install gh-release-install
gh-release-install --help
Or with with pipx:
pipx install gh-release-install
gh-release-install --help
Usage
Usage: gh-release-install [OPTIONS] REPOSITORY ASSET DESTINATION
Install GitHub release file on your system.
The REPOSITORY argument define the Github REPOSITORY org/repo to get the
release from.
Examples:
mvdan/sh
prometheus/prometheus
The ASSET argument define the release ASSET filename. Note that ASSET may
contain variables such as '{version}' or '{tag}'.
Examples:
shfmt_{tag}_linux_amd64
prometheus-{version}.linux-amd64.tar.gz
The DESTINATION argument define the DESTINATION path for the downloaded
file. Note that DESTINATION may contain variables such as '{version}' or
'{tag}'.
Examples:
/usr/bin/local/shfmt
/opt/prometheus/prometheus
If the release asset is an archive, use the --extract flag to extract the
<filename> from the archive and install the extracted file instead. Note
that <filename> may contain variables such as '{version}' or '{tag}'.
Examples:
--extract prometheus-{version}.linux-amd64/prometheus
To install a specific version, use the --version flag to set the desired
version. With 'latest' the installer will ask the Github API to find the
latest version. The default is 'latest'.
Examples:
latest
v2.28.1
To track the version installed on the system, use the --version-file flag to
define the <filename> where the version should be saved. The default is not
to save this version file. Note that <filename> may contain variables such
as '{destination}'.
Examples:
--version-file /opt/versions/prometheus.version
--version-file {destination}.version
Some full examples:
gh-release-install \
'mvdan/sh' \
'shfmt_{tag}_linux_amd64' \
'/usr/bin/local/shfmt' \
--version 'v3.3.1'
gh-release-install \
'prometheus/prometheus' \
'prometheus-{version}.linux-amd64.tar.gz' \
--extract 'prometheus-{version}.linux-amd64/prometheus' \
'/usr/local/bin/prometheus' \
--version-filename '{destination}.version'
Options:
--extract <filename> Archive member to extract.
--version <version> Release version to install.
--version-file <filename> File to track the version installed.
--help Show this message and exit.
5 Nov 18, 2022
1 Feb 2, 2022
3 Sep 10, 2021
5 Apr 12, 2022
3 Oct 14, 2022
16 May 29, 2022
14 Sep 11, 2022
2 Dec 10, 2021
1 Nov 5, 2021
2 Apr 4, 2022
1 Feb 5, 2022
166 Dec 30, 2022
102 Dec 14, 2022
0 Aug 10, 2021
1 Mar 8, 2022
4 Jan 19, 2022
1 Jan 22, 2022
4 Jul 3, 2021
3 Feb 14, 2022