00. How to Read This Documentation

Supported platforms

Matcha CLI attests one platform today and treats the rest as Best Effort. That is a product decision, not a hint that other OSes are almost official. This article shows how to read the version string and what “no installer” means in practice.

Attested vs Best Effort

PlatformStatus
macOS Apple Silicon (darwin / aarch64)Primary — the attested support target
macOS IntelBest Effort
LinuxBest Effort
WindowsBest Effort

Best Effort means the source may compile and run, and people may report what they see, but Matcha CLI does not claim those platforms are supported. Do not plan a rollout on them as if they were attested. Windows is not a primary supported platform.

You run a local matcha binary. A local source build is a developer build. It is not an attested release artifact.

Read the product version

Two equivalent human-readable entries:

matcha --version
matcha -v
matcha version

-v and -V are the --version flag. version (visible alias v) is the subcommand. Both print the Matcha CLI product SemVer, not internal package versions.

Typical stdout looks like:

matcha 0.0.1-alpha.1 (<short-sha>) [alpha]

The parenthetical commit is the build’s version-with-commit. The [alpha] / [stable] suffix is the cached channel label when one exists; it can be empty.

Machine-readable output is only on the subcommand:

matcha version --json

That prints a JSON object with currentVersion and channel. matcha --version --json is not the same parser path; use matcha version --json.

What “no installer” means in practice

  • You copy matcha onto your PATH yourself (or you run it by path).
  • Uninstall is the reverse: remove those binaries. ~/.matcha is kept unless you delete it on purpose. Do not delete ~/.grok as part of uninstalling Matcha CLI.
  • matcha update, --no-auto-update, and MATCHA_DISABLE_AUTOUPDATER do not contact an updater. Leftover flags are compatibility no-ops.

If another matcha is already on your PATH (an unrelated Homebrew formula is the usual case), do not overwrite it. Call this build by path until you have checked:

command -v matcha
matcha --version

Terminals

The TUI expects a modern terminal. Attested daily use is macOS Apple Silicon. For tmux, SSH, truecolor, and clipboard quirks, use /docs Terminal Support and Troubleshooting and matcha doctor (or /doctor in a session). Those pages do not upgrade a Best Effort OS to supported.

Try this

  1. uname -m — on the attested Mac you should see arm64.
  2. matcha --version and matcha version --json if the binary is on PATH.
  3. Confirm the printed name is matcha and the SemVer is the product version, not an internal package version.

If you are on Intel Mac, Linux, or Windows, you may still build and explore. Treat anything you find as Best Effort evidence, not as a support promise.