> For the complete documentation index, see [llms.txt](https://docs.instl.sh/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.instl.sh/readme.md).

# Welcome

Instl - A zero setup installer for your GitHub projects

Instl is an installation script generator for GitHub projects. It does not need any setup, and can be used to install most GitHub projects on Linux, macOS and Windows.

You can easily add installation commands to your project README - they just work!.

<figure><img src="https://raw.githubusercontent.com/installer/instl/main/demo.gif" alt=""><figcaption><p>Instl demo</p></figcaption></figure>

## Key Features

* 💻 Cross-Platform: Works on Windows, macOS and Linux out of the box
* 🧸 One-Click Installs: Install any GitHub project with just a single command
* 🪶 Web-Based: No need to install Instl - scripts are generated server-side
* ⚙️ Intelligent Configuration: Instl adapts to the project's structure
* 🕊️ On the fly: Installer scripts are created in real-time for each project
* 📊 [Track Your Installs](https://instl.sh/stats): Installation metrics for your projects at your fingertips


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.instl.sh/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.