Skip to content
This repository has been archived by the owner on Aug 24, 2024. It is now read-only.
/ instoll Public archive

A tool to easily install packages from GitHub that have an install.sh file

License

Notifications You must be signed in to change notification settings

instoll-sh/instoll

Repository files navigation

GitHub Release Date GitHub workflow status GitHub License Made with love GitHub Repo stars

Logo

instoll

A tool to easily install packages from GitHub that have an install.sh file

Report Bug · Request Feature


Warning

This project is no longer supported, creating aliases in the repository instoll-aliases will be supported.

If you wish, you can create your own fork of this repository with your changes


ℹ️ About The Project

This project is designed to make it easier to install any tools from GitHub that have an install.sh

🤔 Reason for creating this tool

In order to create a deb/snap package, you need to read a ton of documentation and spend a lot of time literally packaging a simple script 🥵

But there is another option to install the package using the installer (install.sh)

The installer is much easier to write, besides, this option is much more flexible and customizable

Why "instOll" ?

[ɪnˈstɔːl]

This name comes from the word "install" with an Indian accent, as in cool YouTube programming guides from Indians 🙃


📥 Installation

Just run this command:

curl -fsSL https://raw.githubusercontent.com/instoll-sh/instoll/main/install.sh | bash

🚀 Usage

Installing the program

instoll <username>/<repo>

You can also use such a moniker:

instoll <username>.<repo>

Example of program installation from GitHub:

instoll hikariatama/Hikka

This command will download install.sh from the hikariatama/Hikka repo and execute it


You can also use the URL of the installer:

instoll https://useful-tool.com/install.sh

An example of installing Bun:

instoll https://bun.sh/install

Aliases will be added soon for an even easier installation 😏:

instoll bun

🛣️ Roadmap

  • ⚡ Add the ability to use aliases for an even easier installation, for example install hikka or install dotload

See the open issues for a full list of proposed features (and known issues).

🤝 Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

You can start developing on GitHub Codespaces right away

Open in GitHub Codespaces

Or use the usual method on your computer:

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Please make sure to update tests as appropriate.

Also, please read our Code of Conduct, and follow it in all your interactions with the project.

📝 License

This project is MIT licensed.

See LICENSE

📨 Contact

Telegram: @Okinea

❤️ Support

This project is completely free and open source.

If you liked this tool - I would be very grateful if you could support me financially

Here are the details for transfers: