Skip to content

Install

Problem

Yanzi must run locally across different environments with minimal setup.

Release artifacts are published at:

  • https://github.com/chuxorg/yanzi/releases

Install using Homebrew:

brew install chuxorg/yanzi/yanzi

macOS / Linux Install Script

Install the latest release directly from GitHub:

curl -sSL https://raw.githubusercontent.com/chuxorg/yanzi/main/install.sh | bash

The script detects OS and architecture, downloads the matching release asset from https://github.com/chuxorg/yanzi/releases/latest, and installs yanzi into /usr/local/bin when writable or ~/.local/bin otherwise.

Windows

Download yanzi-windows-amd64.zip from the latest release.

Steps:

  1. Extract the archive.
  2. Open a terminal in the extracted directory.
  3. Run yanzi.exe --version.

Direct Binary

Download the appropriate release artifact from the latest release:

  • yanzi-darwin-arm64
  • yanzi-darwin-amd64
  • yanzi-linux-amd64
  • yanzi-windows-amd64.zip containing yanzi.exe

For macOS and Linux:

chmod +x yanzi
./yanzi --version

For Windows, extract the zip and run:

.\yanzi.exe --version

Verify Installation

Run:

yanzi --version

Expected:

yanzi vX.Y.Z

Notes

  • Yanzi runs locally by default.
  • No services or infrastructure are required.
  • HTTP mode is optional and not required for most workflows.
  • Homebrew upgrades depend on the tap formula being refreshed. If brew upgrade yanzi does not install the latest release yet, use the install script instead.