An open API service indexing awesome lists of open source software.

https://github.com/smashedr/install-release

CLI to Install a GitHub Releases. Easily Install GitHub Release binaries with Windows, Linux and macOS Support.
https://github.com/smashedr/install-release

cli golang linux macos windows

Last synced: 3 months ago
JSON representation

CLI to Install a GitHub Releases. Easily Install GitHub Release binaries with Windows, Linux and macOS Support.

Awesome Lists containing this project

README

          

[![GitHub Release Version](https://img.shields.io/github/v/release/smashedr/install-release?logo=github)](https://github.com/smashedr/install-release/releases)
[![GitHub Downloads](https://img.shields.io/github/downloads/smashedr/install-release/total?logo=rolldown&logoColor=white)](https://github.com/smashedr/install-release/releases/latest)
[![Asset Size](https://badges.cssnr.com/gh/release/smashedr/install-release/latest/asset/ir_Windows_x86_64.zip/size?label=asset&lucide=file-archive&color=darkgreen)](https://github.com/smashedr/install-release/releases/latest)
[![Image Size](https://badges.cssnr.com/ghcr/size/smashedr/install-release?label=docker&color=darkgreen)](https://github.com/smashedr/install-release/pkgs/container/install-release)
[![Go Version](https://img.shields.io/github/go-mod/go-version/smashedr/install-release?logo=go&logoColor=white&label=go)](https://github.com/smashedr/install-release/blob/master/go.mod)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=smashedr_install-release&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=smashedr_install-release)
[![Deployment Docs](https://img.shields.io/github/deployments/smashedr/install-release/docs?logo=materialformkdocs&logoColor=white&label=docs)](https://github.com/smashedr/install-release/deployments/docs)
[![Deployment Preview](https://img.shields.io/github/deployments/smashedr/install-release/preview?logo=labex&logoColor=white&label=preview)](https://github.com/smashedr/install-release/deployments/preview)
[![Workflow Release](https://img.shields.io/github/actions/workflow/status/smashedr/install-release/release.yaml?logo=norton&logoColor=white&label=release)](https://github.com/smashedr/install-release/actions/workflows/release.yaml)
[![Workflow Lint](https://img.shields.io/github/actions/workflow/status/smashedr/install-release/lint.yaml?logo=norton&logoColor=white&label=lint)](https://github.com/smashedr/install-release/actions/workflows/lint.yaml)
[![GitHub Last Commit](https://img.shields.io/github/last-commit/smashedr/install-release?logo=listenhub&label=updated)](https://github.com/smashedr/install-release/pulse)
[![GitHub Repo Size](https://img.shields.io/github/repo-size/smashedr/install-release?logo=googlecloudstorage&logoColor=white&label=repo%20size)](https://github.com/smashedr/install-release?tab=readme-ov-file#readme)
[![GitHub Top Language](https://img.shields.io/github/languages/top/smashedr/install-release?logo=devbox)](https://github.com/smashedr/install-release?tab=readme-ov-file#readme)
[![GitHub Contributors](https://img.shields.io/github/contributors-anon/smashedr/install-release?logo=southwestairlines)](https://github.com/smashedr/install-release/graphs/contributors)
[![GitHub Issues](https://img.shields.io/github/issues/smashedr/install-release?logo=codeforces&logoColor=white)](https://github.com/smashedr/install-release/issues)
[![GitHub Discussions](https://img.shields.io/github/discussions/smashedr/install-release?logo=theconversation)](https://github.com/smashedr/install-release/discussions)
[![GitHub Forks](https://img.shields.io/github/forks/smashedr/install-release?style=flat&logo=forgejo&logoColor=white)](https://github.com/smashedr/install-release/forks)
[![GitHub Repo Stars](https://img.shields.io/github/stars/smashedr/install-release?style=flat&logo=gleam&logoColor=white)](https://github.com/smashedr/install-release/stargazers)
[![GitHub Org Stars](https://img.shields.io/github/stars/cssnr?style=flat&logo=apachespark&logoColor=white&label=org%20stars)](https://cssnr.github.io/)
[![Discord](https://img.shields.io/discord/899171661457293343?logo=discord&logoColor=white&label=discord&color=7289da)](https://discord.gg/wXy6m2X8wY)
[![Ko-fi](https://img.shields.io/badge/Ko--fi-72a5f2?logo=kofi&label=support)](https://ko-fi.com/cssnr)

# Install Release

[![Homebrew](https://img.shields.io/badge/homebrew-gray?style=flat-square&logo=homebrew)](#homebrew)
[![Bash](https://img.shields.io/badge/bash-gray?style=flat-square&logo=educative&logoColor=white)](#bash)
[![Powershell](https://img.shields.io/badge/powershell-gray?style=flat-square&logo=cashapp&logoColor=lightblue)](#powershell)
[![Go](https://img.shields.io/badge/source-gray?style=flat-square&logo=go)](#source)
[![Docker Installer](https://img.shields.io/badge/docker_installer-gray?style=flat-square&logo=docker)](#docker)
[![Windows Installer](https://img.shields.io/badge/windows_installer-gray?style=flat-square&logo=data:image/svg%2bxml;base64,PHN2ZyB3aWR0aD0iMjQ5MCIgaGVpZ2h0PSIyNTAwIiB2aWV3Qm94PSIwIDAgMjU2IDI1NyIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiBwcmVzZXJ2ZUFzcGVjdFJhdGlvPSJ4TWlkWU1pZCI+PHBhdGggZD0iTTAgMzYuMzU3TDEwNC42MiAyMi4xMWwuMDQ1IDEwMC45MTQtMTA0LjU3LjU5NUwwIDM2LjM1OHptMTA0LjU3IDk4LjI5M2wuMDggMTAxLjAwMkwuMDgxIDIyMS4yNzVsLS4wMDYtODcuMzAyIDEwNC40OTQuNjc3em0xMi42ODItMTE0LjQwNUwyNTUuOTY4IDB2MTIxLjc0bC0xMzguNzE2IDEuMVYyMC4yNDZ6TTI1NiAxMzUuNmwtLjAzMyAxMjEuMTkxLTEzOC43MTYtMTkuNTc4LS4xOTQtMTAxLjg0TDI1NiAxMzUuNnoiIGZpbGw9IiMwMEFERUYiLz48L3N2Zz4=)](https://github.com/smashedr/install-release/releases/latest/download/ir_Windows_Installer.exe)


Install Release

- [Install](#install)
- [Features](#features)
- [Usage](#usage)
- [Development](#development)
- [Support](#Support)
- [Contributing](#contributing)

CLI to Install a GitHub Release.

Easily Install GitHub Release binaries on Windows, Linux and macOS.

Interactively select the release version, asset, and executable name with automatically detected presets.

[![VHS Tape](https://cssnr.s3.amazonaws.com/install-release/demo.gif)](https://smashedr.github.io/install-release/)

> [!IMPORTANT]
> This project is in development.
> It is functional but may have bugs.

## Features

- Supports Windows, Linux and macOS
- Interactively Select Options
- Set Options w/ Flags or Variables
- Save or Set a Custom `bin` Path
- List and Remove Installed Apps
- Get App Information

[![View Documentation](https://img.shields.io/badge/view_documentation-blue?style=for-the-badge&logo=quicklook)](https://smashedr.github.io/install-release/)

## Install

[![Latest Release](https://img.shields.io/github/v/release/smashedr/install-release?logo=github&label=latest%20release)](https://github.com/smashedr/install-release/releases)
[![Windows Installer](https://img.shields.io/badge/download-windows--installer.exe-blue?logo=data:image/svg%2bxml;base64,PHN2ZyB3aWR0aD0iMjQ5MCIgaGVpZ2h0PSIyNTAwIiB2aWV3Qm94PSIwIDAgMjU2IDI1NyIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiBwcmVzZXJ2ZUFzcGVjdFJhdGlvPSJ4TWlkWU1pZCI+PHBhdGggZD0iTTAgMzYuMzU3TDEwNC42MiAyMi4xMWwuMDQ1IDEwMC45MTQtMTA0LjU3LjU5NUwwIDM2LjM1OHptMTA0LjU3IDk4LjI5M2wuMDggMTAxLjAwMkwuMDgxIDIyMS4yNzVsLS4wMDYtODcuMzAyIDEwNC40OTQuNjc3em0xMi42ODItMTE0LjQwNUwyNTUuOTY4IDB2MTIxLjc0bC0xMzguNzE2IDEuMVYyMC4yNDZ6TTI1NiAxMzUuNmwtLjAzMyAxMjEuMTkxLTEzOC43MTYtMTkuNTc4LS4xOTQtMTAxLjg0TDI1NiAxMzUuNnoiIGZpbGw9IiMwMEFERUYiLz48L3N2Zz4=)](https://github.com/smashedr/install-release/releases/latest/download/ir_Windows_Installer.exe)

#### Homebrew

```shell
brew install cssnr/tap/install-release
```

#### Bash

```shell
curl 'https://raw.githubusercontent.com/smashedr/install-release/refs/heads/master/scripts/install.sh' | bash
```

💾 Alternatively, you can manually [download a release](https://github.com/smashedr/install-release/releases).

#### PowerShell

```powershell
iex (iwr -useb 'https://raw.githubusercontent.com/smashedr/install-release/refs/heads/master/scripts/install.ps1').Content
```

🪟 Windows users can download the [Windows Installer](https://github.com/smashedr/install-release/releases/latest/download/ir_Windows_Installer.exe).

#### Source

```shell
go install github.com/smashedr/install-release@latest
```

#### Docker

```shell
docker run --rm -itv ~/bin:/out ghcr.io/smashedr/ir:latest -b /out smashedr/install-release
```

_Note: Docker requires you to mount the target bin directory._

[![View Documentation](https://img.shields.io/badge/view_documentation-blue?style=for-the-badge&logo=quicklook)](https://smashedr.github.io/install-release/)

## Usage

Install the latest release.

```shell
ir owner/repo
```

Include the latest pre-releases.

```shell
ir owner/repo --pre
```

Install a specific version/tag.

```shell
ir owner/repo v1.0.0
```

Specify repo in any format:

```shell
ir owner[/ ]repo
ir owner[/ ]repo[@:/ ]tag
ir github.com/owner[/ ]repo[@:/ ]tag
ir https://github.com/owner[/ ]repo[@:/ ]tag
```

View Examples

```shell
ir smashedr bup
ir smashedr/bup
ir smashedr bup latest
ir smashedr/bup latest
ir smashedr/bup/latest
ir smashedr/bup:latest
ir smashedr/bup@latest
ir github.com/smashedr/bup
ir github.com/smashedr/bup/latest
ir https://github.com/smashedr/bup
ir https://github.com/smashedr/bup@latest
```

Skip the asset and name prompts.

```shell
ir owner/repo -y
```

Set the asset and name inline.

```shell
ir owner/repo -n name -a asset_name.zip
```

Install to a different bin directory.

```shell
ir owner/repo -b /usr/local/bin
```

Get package information.

```shell
ir info owner/repo
```

List installed apps.

```shell
ir list
```

Remove an app.

```shell
ir remove
```

Remove an app by name.

```shell
ir remove name
```

Edit the settings.

```shell
ir config
```

[![View Documentation](https://img.shields.io/badge/view_documentation-blue?style=for-the-badge&logo=quicklook)](https://smashedr.github.io/install-release/)

# Development

Go:

```shell
go run main.go
```

Task:

```shell
task build
task lint
```

Docs:

```shell
task docs
```

Inno Setup:

```shell
task inno
```

# Support

If you run into any issues or need help getting started, please do one of the following:

- Report an Issue:
- Q&A Discussion:
- Request a Feature:
- Chat with us on Discord:

[![Features](https://img.shields.io/badge/features-brightgreen?style=for-the-badge&logo=rocket&logoColor=white)](https://github.com/smashedr/install-release/issues/new?template=1-feature.yaml)
[![Issues](https://img.shields.io/badge/issues-red?style=for-the-badge&logo=southwestairlines&logoColor=white)](https://github.com/smashedr/install-release/issues)
[![Discussions](https://img.shields.io/badge/discussions-blue?style=for-the-badge&logo=livechat&logoColor=white)](https://github.com/smashedr/install-release/discussions)
[![Discord](https://img.shields.io/badge/discord-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/wXy6m2X8wY)

# Contributing

If you would like to submit a PR, please review the [CONTRIBUTING.md](#contributing-ov-file).

Please consider making a donation to support the development of this project
and [additional](https://cssnr.com/) open source projects.

[![Ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/cssnr)

For a full list of current projects visit: [https://cssnr.github.io/](https://cssnr.github.io/)





Star History Chart