> For the complete documentation index, see [llms.txt](https://docs.flatredball.com/gum/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flatredball.com/gum/gum-tool/setup/running-from-source.md).

# Running from Source

## Introduction

Gum is an open source project so you can run it from source instead of running the pre-compiled project. Running from source is not a requirement, and is only needed if you intend to contribute to Gum or if you'd like to diagnose problems in a debugger.

## Obtaining the source code

1. Download the source file from [GitHub](https://github.com/vchelaru/gum)
   1. If you downloaded the .zip file from the GitHub main page, unzip the file
   2. If you downloaded the file through a Git client, be sure to be on the `main` branch

<figure><img src="https://2695663588-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M_fzQmxQ1VeUFHcoo2c%2Fuploads%2Fgit-blob-bddb7866326fea4a760645b620929347df6a419f%2F02_08%2020%2011.png?alt=media" alt=""><figcaption><p>Gum repository in Github Desktop</p></figcaption></figure>

## Running the code

Building Gum requires the [.NET 10 SDK](https://dotnet.microsoft.com/download). Gum builds and runs from source on Windows, macOS, and Linux.

### From an IDE

1. Locate the `Gum.slnx` file at the root of the repository (`Gum.Wpf.sln` is the older Windows-only WPF tool, which no longer ships)
2. Open it in Visual Studio, Rider, or VS Code
3. Build the whole solution rather than only the startup project. This guarantees that all plugins are built and copied correctly. For more information see below.
4. Run the **Gum.Avalonia** project, which is the Gum tool. It is the solution's startup project.

<figure><img src="https://2695663588-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-M_fzQmxQ1VeUFHcoo2c%2Fuploads%2Fgit-blob-d9ff318594dbe6de46b1827efd7b897bf080d057%2Fgb-006.png?alt=media" alt=""><figcaption><p>Build -> Rebuild Solution in Visual Studio</p></figcaption></figure>

### From the command line

Run the following from the root of the repository:

```sh
dotnet build Gum.slnx
dotnet run --no-build --project Tool/Gum.Avalonia
```

To open a project on startup, add its path after `--`:

```sh
dotnet run --no-build --project Tool/Gum.Avalonia -- path/to/MyProject.gumj
```

### Building Plugins

Some of Gum's features live in plugin projects, which copy themselves into the tool's `Plugins` folder when they build. Building only the Gum.Avalonia project (for example, by pressing F5 in Visual Studio after changing a plugin) does not rebuild them. Build the whole solution, or run `dotnet build Gum.slnx`, after changing a plugin.

## Troubleshooting

### A feature added by a plugin is missing

If a menu item or tab that comes from a plugin is missing, build the whole solution. To see which plugins loaded, select **Edit** > **Settings...** and click **Plugins**. The page also lists any plugin that was found but could not be loaded, along with the reason.


---

# 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 by asking a question.

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

```
GET https://docs.flatredball.com/gum/gum-tool/setup/running-from-source.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 `automate deployments from our CI pipeline` 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.
