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/
    chmod +x /usr/local/bin/executable_name

  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

Nix​

You can run Matcha directly using Nix flakes:

nix run github:floatpane/matcha

Or install it into your profile:

nix profile install github:floatpane/matcha

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​

winget install --id=floatpane.matcha

Manual Binary Download​

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

  1. Move the executable to a permanent, dedicated location on your computer (e.g., C:\CLI Tools\MyTool).

  2. Open the System Properties window by searching for "environment variables" in the Windows Start menu and selecting "Edit the system environment variables".

  3. Click the "Environment Variables..." button at the bottom of the System Properties window, under the "Advanced" tab.

  4. Locate the "Path" variable in the "User variables for [Your Username]" section (for access only by your user account) or the "System variables" section (for all users).

  5. Double-click on the "Path" variable to edit it.

  6. Add the path to your executable's folder:

    In the "Edit environment variable" window, click "New". Type or paste the full path to the folder where your executable is located (e.g., C:\CLI Tools\MyTool). Click "OK" on all open windows to save the changes.

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 .