> 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/basics/running-gauntlet.md).

# Running Gauntlet

{% hint style="info" %}
All Gauntlet files end in `.gaunt`
{% endhint %}

## Transpiling Code

To transpile Gauntlet code to Go code, simply provide the target `.gaunt` file. If no errors are found, Gauntlet will put your transpiled code in a `.go` file (in the same folder as your Gauntlet one) with the corresponding name. In the example below, the file name is `MyTestFile.gaunt`, which means `MyTestFile.go` will contain the resulting code.

### Example

{% tabs %}
{% tab title="Linux & Mac" %}

```
./gauntlet MyTestFile.gaunt
```

{% endtab %}

{% tab title="Windows" %}

```
.\gauntlet.exe MyTestFile.gaunt
```

{% endtab %}
{% endtabs %}

## Run Immediately After Transpiling

You can run your transpiled code immediately after it's created by utilizing the `run` command.

### Example

{% tabs %}
{% tab title="Linux & Mac" %}

```
./gauntlet MyTestFile.gaunt run 
```

{% endtab %}

{% tab title="Windows" %}

```
.\gauntlet MyTestFile.gaunt run 
```

{% endtab %}
{% endtabs %}

## Skipping formatting

By default, your transpiled code will be formatted with `go fmt`. If, for some reason, you don't want this, you can stop it from happening with the `--no-format` flag.&#x20;

### Example

{% tabs %}
{% tab title="Linux & Mac" %}

```
./gauntlet MyTestFile.gaunt run --no-format
```

{% endtab %}

{% tab title="Windows" %}

```
.\gauntlet MyTestFile.gaunt run --no-format
```

{% endtab %}
{% endtabs %}

**-OR-**

{% tabs %}
{% tab title="Linux & Mac" %}

```
./gauntlet MyTestFile.gaunt --no-format
```

{% endtab %}

{% tab title="Windows" %}

```
.\gauntlet MyTestFile.gaunt --no-format
```

{% endtab %}
{% endtabs %}


---

# 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/basics/running-gauntlet.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.
