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

# Installation

{% hint style="success" %}
For the sake of organization, it's recommended that you make a Gauntlet folder (e.g. `Gauntlet test`) to put the gauntlet executable in, along with your `.gaunt` files.
{% endhint %}

{% hint style="warning" %}
Go must be installed on your computer for Gauntlet to work
{% endhint %}

## Installing Gauntlet

{% stepper %}
{% step %}

### Head to the [GitHub Releases page](https://github.com/gauntlet-lang/gauntlet/releases) and download for your OS

* The GitHub Releases page is the only official source for distributing Gauntlet
* Linux, Windows, and MacOS are supported
* Be sure to download the most recent version
  {% endstep %}

{% step %}

### Prepare for usage

* Rename the file you just downloaded to `gauntlet` for easy access
  * You can use your file manager to do this
* Mark the file as executable (only required on Linux and MacOS)
  * `chmod +x gauntlet` 
* Move to PATH for universal access (optional) 
  * There are plenty of articles online for how you can do this for your respective OS
    {% endstep %}

{% step %}

### Verify Installation Works

* In the same folder as the `gauntlet` file, run:
  * Linux/MacOS: `./gauntlet test`
  * Windows:  `.\gauntlet.exe test`
* If you see `You've successfully installed Gauntlet!`, then you're all set!
* If you don't see that message, then join the [Discord server](https://discord.gg/eK3zJYrN58) and ask for help
  {% endstep %}
  {% endstepper %}


---

# 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 current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://gauntletlang.gitbook.io/docs/installation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.