# macOS

*Last updated: January 2026*

This guide explains how to build and run **Abey (`gabey`)** from source on macOS.

***

### Prerequisites

Before building Abey, ensure the following tools are installed:

* **Git**
* **Homebrew**
* **Go (latest stable version)**

If Go is not installed, you can install it using Homebrew.

***

### Building from Source

#### Clone the Repository

Clone the official Abey repository to a directory of your choice:

```bash
git clone https://github.com/abeyfoundation/go-abey.git
```

***

#### Install Go

Install the Go compiler using Homebrew:

```bash
brew install go
```

***

#### Build `gabey`

Navigate to the repository, check out the release branch, and build the client:

```bash
cd go-abey
git checkout release/2.0
make gabey
```

***

#### Install Xcode Command Line Tools (if needed)

If you encounter errors related to macOS system headers, install the Xcode Command Line Tools:

```bash
xcode-select --install
```

Then re-run the build command.

***

### Running the Node

After a successful build, start the Abey node using:

```bash
build/bin/gabey
```

This will launch the Abey command-line client on macOS.

***

If you encounter issues, verify that:

* Go is correctly installed and available in your `PATH`
* Xcode Command Line Tools are installed


---

# Agent Instructions: 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:

```
GET https://docs.abey.com/installation/building_abey/instructions_macos.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.