A cli tool to install tools based on your device info directly from github releases and keep them updated.
Project description
Install Release ๐
install-release
is a CLI tool to install any tool for your device directly from their GitHub releases and keep them updated. Consider it as a small package manager to install tools from GitHub releases.
This can be any tool you want to install, which is pre-compiled for your device and present on GitHub releases.
INFO: It's mainly for installing tools that are not directly available officially by package managers like
apt, yum, pacman
etc.
Table of Contents
- Install Release ๐
- Table of Contents
- Getting started
- Prerequisites
- Install
install-release
package - Updating
install-release
- Example usage
install-release --help
- Install completion for cli
- Install tool from GitHub releases
- List installed tools
- Remove installed release
- Update all previously installed tools to the latest version
- Pull state templates for installing tools.
- Hold Update to specific installed tool.
- Config tool installation path
- Config updates for pre-release versions
- Configure GitHub token for higher rate limit
Getting started
# Install install-release
pip install -U install-release
# Example Installation a tool named `gron` directly from its GitHub releases
# install-release get [GITHUB-URL]
โฏ install-release get https://github.com/tomnomnom/gron
Checking for gron is installed using installed-release
:
โฏ which gron
/home/noobi/bin/gron
โฏ gron --help
Transform JSON (from a file, URL, or stdin) into discrete assignments to make it greppable
... # more
Prerequisites
-
python3.8 or higher
-
Default releases Installation Path is:
~/bin/
, This is the path where installed tools will get stored. -
In order to run installed tools, you need to add the following line to your
~/.bashrc
or~/.zshrc
file:
export PATH=$HOME/bin:$PATH
Install install-release
package
pip install -U install-release
Updating install-release
For seeing version:
install-release me --version
For updating:
install-release me --upgrade
Example usage install-release --help
# Help page
โฏ install-release --help
Usage: install-release [OPTIONS] COMMAND [ARGS]...
GitHub Release Installer, based on your system
Commands:
get | Install GitHub release, cli tool
ls | list all installed releases, cli tools
rm | remove any installed release, cli tools
upgrade | Upgrade all installed releases, cli tools
state | show currently stored state
config | Set configs for tool
pull | Install tools from a remote state
hold | Keep updates a tool on hold.
me | Update install-release tool.
For sub-command help use: install-release <sub-command> --help
Example: install-release get --help
You can shorten the command by setting the alias to your .bashrc
or .zshrc
alias ir="install-release"
after this you can you alias directly for easiness
Example: ir get --help
Install completion for cli
# install-release --install-completion [SHELL: bash|zsh|fish|powershell]
# Example for zsh:
install-release --install-completion zsh
Install tool from GitHub releases
โฏ install-release get "https://github.com/ahmetb/kubectx"
๐ Repo : ahmetb/kubectx
๐ Stars : 13295
โจ Language : Go
๐ฅ Title : Faster way to switch between clusters and namespaces in kubectl
๐ Install: kubectx
โโโโโโโโโโโณโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโณโโโโโโโโโโณโโโโโโโโโโณโโโโโโโโโโโโ
โ Name โ Selected Item โ Version โ Size Mb โ Downloads โ
โกโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฉ
โ kubectx โ kubectx_v0.9.4_linux_x86_64.tar.gz โ v0.9.4 โ 1.0 โ 43811 โ
โโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโดโโโโโโโโโโดโโโโโโโโโโโโ
Install this tool (Y/n): y
INFO Downloaded: 'kubectx_v0.9.4_linux_x86_64.tar.gz' at /tmp/dn_kubectx_ph6i7dmk utils.py:159
INFO install /tmp/dn_kubectx_ph6i7dmk/kubectx /home/noobi/bin/kubectx core.py:132
INFO Installed: kubectx
# checking if kubectx is installed
โฏ which kubectx
/home/noobi/bin/kubectx
โฏ kubectx --version
0.9.4
List installed tools
โฏ install-release ls
Installed tools
โโโโโโโโโโโโโณโโโโโโโโโโณโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ Name โ Version โ Url โ
โกโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฉ
โ terrascan โ v1.15.2 โ https://github.com/tenable/terrascan โ
โ gron โ v0.7.1 โ https://github.com/tomnomnom/gron โ
โ kubectx โ v0.9.4 โ https://github.com/ahmetb/kubectx โ
โโโโโโโโโโโโโดโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
Remove installed release
# Remove installed release
โฏ install-release rm gron
INFO Removed: gron
Update all previously installed tools to the latest version
โฏ install-release upgrade
Fetching: https://github.com/tenable/terrascan#terrascan
Fetching: https://github.com/ahmetb/kubectx#kubectx
Following tools will be upgraded:
terrascan
Upgrade these tools, (Y/n): y
Updating: terrascan, v1.15.0 => v1.15.2
INFO Downloaded: 'terrascan_1.15.2_Linux_x86_64.tar.gz' at /tmp/dn_terrascan_0as71a6v
INFO install /tmp/dn_terrascan_0as71a6v/terrascan ~/bin/terrascan
INFO Installed: terrascan
Progress... โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ 100% 0:00:00
Pull state templates for installing tools.
You can push your state to somewhere like GitHub and use it for any other device, to make a sync for tools installed via install-release
โฏ install-release pull --url https://raw.githubusercontent.com/Rishang/dotFiles/main/templates/install-release/state.json
Hold Update to specific installed tool.
In case you want to hold an update to the specific tool, you can use hold {tool-name}
command which will pause update for that tool.
Example: keep tool named k9s update on hold
โฏ install-release hold k9s
INFO Update on hold for, k9s to True
You can list tools on hold updates by ls --hold
command
โฏ install-release ls --hold
Installed tools kept on hold
โโโโโโโโณโโโโโโโโโโณโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ Name โ Version โ Url โ
โกโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฉ
โ k9s โ v0.26.7 โ https://github.com/derailed/k9s โ
โโโโโโโโดโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
In case you want to unhold update to the specific tool, you can use hold --unset {tool-name}
command by which it will pause update for that tool.
โฏ install-release hold --unset k9s
INFO Update on hold for, k9s to False
Config tool installation path
โฏ install-release config --path ~/.local/bin
INFO updated path to: ~/.local/bin
INFO Done
Config updates for pre-release versions
This is useful when you want to install pre-release versions of tools like beta or alpha releases. By default, it is set to False
in which case it will only check for latest release.
โฏ install-release config --pre-release
Configure GitHub token for higher rate limit
โฏ install-release config --token [your github token]
INFO: Update token
INFO: Done.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for install_release-0.3.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0ae6283efe85bbd0323ca1407c96fc2320bcff59b1b2dd711874e3a5b6cf9af1 |
|
MD5 | 5930994d0cfd885b0e3d94c635d93854 |
|
BLAKE2b-256 | fba67a90863b836f031d9c884bb0ac1f73666e72f73cfff27e0844461565ed04 |