Install Release is a CLI tool by name ir to install any single-binary executable package for your device(Linux/MacOS/WSL) directly from their GitHub or GitLab releases and keep them updated. Consider it as a CLI to install, update and remove any single binary tools from GitHub/GitLab releases.
This can be any tool you want to install, which is pre-compiled for your device and present on GitHub or GitLab releases.
INFO: It's mainly for installing tools that are not directly available officially by package managers like
apt, yum, pacman, brewetc.
- Table of Contents 📚
- Getting started ⚡
- Prerequisites 📋
- Updating
install-release🔄 - Example usage
ir --help💡- Install completion for cli 🎠
- Install tool from GitHub/GitLab releases 🌈
- Install specific release asset from GitHub/GitLab 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 ✋
- Configure tool installation path 🗂️
- Configure updates for pre-release versions 🔌
- Configure GitHub/GitLab tokens for higher rate limit 🔑
Example: Installing deno (Rust-based JavaScript runtime) directly from its GitHub releases:
# Usage: ir get [GITHUB-URL or GITLAB-URL]
❯ ir get https://github.com/denoland/denoVerify the installation:
❯ which deno
~/bin/deno
❯ deno --version
deno 1.46.3 ...Example: Installing GitLab CLI with a custom binary name glab:
❯ ir get https://gitlab.com/gitlab-org/cli -n glabVerify the installation:
❯ which glab
~/bin/glab
❯ glab --version
glab 1.80.0 ...Once installed, you can manage your tools with these simple commands:
- List:
ir ls— See all installed tools and versions. - Update:
ir upgrade— Upgrade all installed tools to their latest releases. - Remove:
ir rm deno— Remove a tool from your system.
For more details, check the Table of Contents.
- python3.8 or higher
- libmagic
- Default installation path:
~/bin/(Ensure this is in yourPATH)
# Add this to your ~/.bashrc or ~/.zshrc
export PATH=$HOME/bin:$PATHFor seeing version:
ir me --versionFor updating:
ir me --upgrade# Help page
❯ ir --help
Usage: ir [OPTIONS] COMMAND [ARGS]...
GitHub / GitLab release installer based on your system (Linux/MacOS)
Commands:
get | Install GitHub/GitLab repository CLI tool from its releases
ls | List all installed CLI tools
rm | Remove any installed CLI tool
upgrade | Upgrade all installed CLI tools from their repositories
state | Show the current stored state of Install-Release
config | Set configs for Install-Release
pull | Install tools from the remote install-release state URL
hold | Keep an installed CLI tool's updates on hold.
me | Update the Install-Release tool.
For sub-command help use: ir <sub-command> --help
Example: ir get --help
# ir --install-completion [SHELL: bash|zsh|fish|powershell]
# Example for zsh:
ir --install-completion zsh❯ ir 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
In rare cases where install-release does not automatically find the correct release file for your system, you can manually specify the release file name. There are two ways to do this:
During the installation prompt, type ? to view all available release assets and select the one you want:
❯ ir get https://github.com/ekzhang/bore
📑 Repo : ekzhang/bore
🌟 Stars : 8234
✨ Language : Rust
🔥 Title : A simple CLI tool for making tunnels to localhost
🚀 Install: bore
┏━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━┓
┃ Name ┃ Selected Item ┃ Version ┃ Size Mb ┃ Downloads ┃
┡━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━┩
│ bore │ bore-v0.4.0-x86_64-unknown-linux-musl... │ v0.4.0 │ 1.2 │ 1523 │
└──────┴──────────────────────────────────────────┴─────────┴─────────┴───────────┘
Path: /home/noobi/bin
Install this tool (Y/n/?): ?
📦 Available Assets for bore
┏━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┓
┃ ID ┃ Filename ┃ Size (MB) ┃ Downloads ┃
┡━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━┩
│ 1 │ bore-v0.4.0-x86_64-unknown-linux-musl.tar.gz │ 1.2 │ 1523 │
│ 2 │ bore-v0.4.0-x86_64-unknown-linux-gnu.rpm │ 1.3 │ 845 │
│ 3 │ bore-v0.4.0-aarch64-unknown-linux-musl.deb │ 1.1 │ 234 │
│ 4 │ bore-v0.4.0-x86_64-apple-darwin.dmg │ 1.2 │ 456 │
│ 5 │ bore-v0.4.0-x86_64-apple-darwin.tar.gz │ 1.2 │ 1523 │
└────┴─────────────────────────────────────────────────┴───────────┴───────────┘
Enter your desired file ID to install (or 'n' to cancel): 3The tool will automatically parse the selected filename into keywords and store them for future upgrades.
You can also specify the release file name directly using the -a flag:
❯ ir get [GITHUB-URL or GITLAB-URL] -a [release asset filename]Example: Installing the bore tool from GitHub with the release file name bore-v0.4.0-arm-unknown-linux-musleabi.tar.gz. Here, the keywords generated are: bore, v0.4.0, arm, linux, musleabi
❯ ir get https://github.com/ekzhang/bore -a bore-v0.4.0-arm-unknown-linux-musleabi.tar.gzHow it works:
- The tool parses the release file name into keywords (removing version numbers and file extensions)
- These keywords are stored in the state file to match the correct release file during future tool upgrades
- This ensures consistent upgrades to the same release variant
Note: If
install-releasefails to identify the correct release package for your system, please raise a GitHub issue to help improve the tool.
❯ ir 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
❯ ir rm gron
INFO Removed: gron❯ ir 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:00You can push your state to somewhere like GitHub and use it on any other device to sync the tools installed via ir.
❯ ir pull --url https://raw.githubusercontent.com/Rishang/dotFiles/main/templates/install-release/state.jsonIn case you want to hold an update for a specific tool, you can use the hold {tool-name} command which will pause updates for that tool.
Example: Keep tool named k9s update on hold:
❯ ir hold k9s
INFO Update on hold for, k9s to TrueYou can list tools on hold updates by using the ls --hold command:
❯ ir ls --hold
Installed tools kept on hold
┏━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Name ┃ Version ┃ Url ┃
┡━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ k9s │ v0.26.7 │ https://github.com/derailed/k9s │
└──────┴─────────┴───────────────────────────────────┘In case you want to remove the update hold for a specific tool, you can use the hold --unset {tool-name} command:
❯ ir hold --unset k9s
INFO Update on hold for, k9s to False
❯ ir config --path ~/.local/bin
INFO Updated path to: ~/.local/bin
INFO DoneThis 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 the latest stable release.
❯ ir config --pre-releaseFor GitHub:
❯ ir config --github-token [your github token]
INFO: Updated GitHub token
INFO: Done.For GitLab:
❯ ir config --gitlab-token [your gitlab token]
INFO: Updated GitLab token
INFO: Done.
![@dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}
