instl

README

instl

Instl is an installer that can install most GitHub projects on your system with a single command.

---

Installation | Documentation | Contributing

---

Instl is an installer that can install most GitHub projects on your system with a single command.
Additionally, Instl provides a server that generates dynamic scripts that install a GitHub project.

Official docs: https://docs.instl.sh

Web Installer

The web install command can be used by anyone and does not require anything to be installed. Running the web install command will download instl and install the given GitHub project. After that, instl will be removed from the system again.

The instl web installer is a single command, which everyone can run, to install a GitHub project. This is the basic syntax, which will return an install script from our API server:

                     ┌ The GitHub username of the project
                     |        ┌ The GitHub repository name of the project
                     |        |       ┌ The platform, see "Valid Platforms"
                     |        |       |
https://instl.sh/username/reponame/platform

Valid Platforms

Valid Platforms	Parameter
Windows	windows
macOS	macos
Linux	linux

Running the web installer command

Different operating systems need different commands to download and run the web installer script. You can include those commands in your GitHub project, to provide a user-friendly installer for your CLI without any setup!

Windows

This command will download and execute the web installer script for windows. You have to execute it in a powershell terminal.

iwr -useb instl.sh/username/reponame/windows | iex

macOS

This command will download and execute the web installer script for macOS.

curl -fsSL instl.sh/username/reponame/macos | bash

Linux

This command will download and execute the web installer script for linux.

curl -fsSL instl.sh/username/reponame/linux | bash

Installation

If you want to install instl directly to your system, to be able to install most GitHub projects with ease, you can use the following command:

Windows

iwr instl.sh/installer/instl/windows | iex

macOS

curl -sSL instl.sh/installer/instl/macos | bash

Linux

curl -sSL instl.sh/installer/instl/linux | bash