Skip to main content

Installation Guide

Welcome to the installation guide for Matcha.

 MacOS

🍺 Homebrew

The recommended way to install Matcha on macOS is via Homebrew.

brew tap floatpane/matcha
brew install floatpane/matcha/matcha

After installation, run:

matcha

[!WARNING] If you have the "other" Matcha already installed, you will have to rename the executable to avoid conflicts.

Manual Binary Download

You can download pre-compiled binaries from the Releases page.

  1. 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).
  2. Extract the archive.
  3. Move the binary to your path:
    mv matcha /usr/local/bin/
  4. Run it:
    matcha

🐧 Linux

🍺 Homebrew

You can also install Matcha on Linux via Homebrew.

brew tap floatpane/matcha
brew install floatpane/matcha/matcha

Snap

Matcha is available on the Snap Store.

sudo snap install matcha

Flatpak

You can install Matcha via Flatpak using the following command:

flatpak install https://matcha.floatpane.com/matcha.flatpakref

Manual Binary Download

You can download pre-compiled binaries from the Releases page.

  1. 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).
  2. Extract the archive.
  3. Move the binary to your path:
    mv matcha /usr/local/bin/
  4. Run it:
    matcha

🪟 Windows

Currently, there is no native support for Windows. Please see issue #123 for more details.

WSL

You can run Matcha on Windows using WSL (Windows Subsystem for Linux).

Once you have WSL installed and set up, you can follow the Linux installation instructions inside your WSL terminal.

🏗️ Building from Source

If you have Go installed, you can build Matcha from source:

go build .