1# Installation Guide
  2
  3Welcome to the installation guide for Matcha.
  4
  5## Table of Contents
  6
  7- [ MacOS](#macos)
  8  - [Homebrew](#homebrew)
  9  - [Manual Binary Download](#manual-binary-download)
 10- [🐧 Linux](#linux)
 11  - [Homebrew](#homebrew-1)
 12  - [Snap](#snap)
 13  - [Flatpak](#flatpak)
 14  - [Manual Binary Download](#manual-binary-download-1)
 15- [🪟 Windows](#windows)
 16  - [WSL](#wsl)
 17- [🏗️ Building from Source](#building-from-source)
 18
 19##  MacOS
 20
 21### 🍺 Homebrew
 22
 23The recommended way to install Matcha on macOS is via Homebrew.
 24
 25```bash
 26brew tap floatpane/matcha
 27brew install floatpane/matcha/matcha
 28```
 29
 30After installation, run:
 31
 32```bash
 33matcha
 34```
 35
 36> [!WARNING]
 37> If you have the [*"other"* Matcha](https://github.com/piqoni/matcha) already installed, you will have to rename the executable to avoid conflicts.
 38
 39### Manual Binary Download
 40
 41You can download pre-compiled binaries from the [Releases page](https://github.com/floatpane/matcha/releases).
 42
 431. Download the appropriate archive for your architecture (e.g., `matcha_0.17.0_darwin_amd64.tar.gz` or `matcha_0.17.0_darwin_arm64.tar.gz`).
 442. Extract the archive.
 453. Move the binary to your path:
 46   ```bash
 47   mv matcha /usr/local/bin/
 48   ```
 494. Run it:
 50   ```bash
 51   matcha
 52   ```
 53
 54## 🐧 Linux
 55
 56### 🍺 Homebrew
 57
 58You can also install Matcha on Linux via Homebrew.
 59
 60```bash
 61brew tap floatpane/matcha
 62brew install floatpane/matcha/matcha
 63```
 64
 65### Snap
 66
 67Matcha is available on the Snap Store.
 68
 69```bash
 70sudo snap install matcha
 71```
 72
 73### Flatpak
 74
 75You can install Matcha via Flatpak using the following command:
 76
 77```bash
 78flatpak install https://matcha.floatpane.com/matcha.flatpakref
 79```
 80
 81### Manual Binary Download
 82
 83You can download pre-compiled binaries from the [Releases page](https://github.com/floatpane/matcha/releases).
 84
 851. Download the appropriate archive for your architecture (e.g., `matcha_0.17.0_linux_amd64.tar.gz` or `matcha_0.17.0_linux_arm64.tar.gz`).
 862. Extract the archive.
 873. Move the binary to your path:
 88   ```bash
 89   mv matcha /usr/local/bin/
 90   ```
 914. Run it:
 92   ```bash
 93   matcha
 94   ```
 95
 96## 🪟 Windows
 97
 98Currently, there is no native support for Windows. Please see issue [#123](https://github.com/floatpane/matcha/issues/123) for more details.
 99
100### WSL
101
102You can run Matcha on Windows using [WSL (Windows Subsystem for Linux)](https://learn.microsoft.com/en-us/windows/wsl/install).
103
104Once you have WSL installed and set up, you can follow the [Linux](#linux) installation instructions inside your WSL terminal.
105
106## 🏗️ Building from Source
107
108If you have Go installed, you can build Matcha from source:
109
110```bash
111go build .
112```