> ## Documentation Index
> Fetch the complete documentation index at: https://hayate.shiina.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Install Hayate on macOS, Linux, Windows, and Android

> Download and install the Hayate binary on macOS, Linux, Windows (winget or PowerShell), Android Termux, or build from source with cargo.

Hayate ships as a single self-contained binary with no runtime dependencies. You can install it on macOS, Linux, Windows, or Android (Termux) in under a minute using the one-liner for your platform, or build it from source via Cargo if you prefer. Pick the tab that matches your system and you'll be ready to transfer files immediately.

<Tabs>
  <Tab title="macOS & Linux">
    Run the install script in your terminal. It downloads the latest release binary for your architecture and places it in `~/.local/bin` (or `/usr/local/bin` if you have write access):

    ```bash theme={null}
    curl -sSf https://shiinasaku.github.io/Hayate/install.sh | bash
    ```

    The script detects your OS and CPU architecture automatically. It works on Apple Silicon, Intel Macs, x86\_64 Linux, and ARM Linux.
  </Tab>

  <Tab title="Windows">
    **Using winget (recommended)**

    If you have the Windows Package Manager installed, run:

    ```powershell theme={null}
    winget install ShiinaSaku.Hayate
    ```

    **Using PowerShell**

    Alternatively, run the install script directly from PowerShell:

    ```powershell theme={null}
    irm https://shiinasaku.github.io/Hayate/install.ps1 | iex
    ```

    This downloads the latest `.exe` release and adds it to your `PATH`. A Unicode-capable terminal such as Windows Terminal is recommended for the best experience with progress bars and color output.
  </Tab>

  <Tab title="Android (Termux)">
    Hayate runs natively on Android inside [Termux](https://termux.dev). Download the prebuilt `aarch64` binary directly from GitHub Releases:

    ```bash theme={null}
    curl -sSfL "https://github.com/ShiinaSaku/Hayate/releases/latest/download/hayate-termux-arm64" \
      -o "$PREFIX/bin/hayate" && chmod +x "$PREFIX/bin/hayate"
    ```

    This places the binary in Termux's `bin` directory so it is immediately available on your `PATH`. Automatic peer discovery works on most home routers where the Android device and your other machines share the same LAN segment.
  </Tab>

  <Tab title="Cargo (crates.io)">
    If you have Rust installed, you can build and install Hayate directly from [crates.io](https://crates.io/crates/hayate-cli):

    ```bash theme={null}
    cargo install hayate-cli
    ```

    Cargo compiles the binary for your host platform and places it in `~/.cargo/bin`. Make sure that directory is on your `PATH`.

    <Note>
      Building from source requires **Rust 1.96 or later**. Run `rustup update stable` to get the latest toolchain if your version is older.
    </Note>
  </Tab>
</Tabs>

## Verify Your Installation

After installing, confirm that Hayate is on your `PATH` and check the version:

```bash theme={null}
hayate --version
```

You should see output like `hayate 4.x.x`. If the command is not found, ensure the install directory is included in your shell's `PATH` and restart your terminal session.

## Prebuilt Binaries

Every release includes prebuilt binaries for all supported platforms. If you prefer to download a binary manually rather than using an install script, visit the [GitHub Releases page](https://github.com/ShiinaSaku/Hayate/releases) and grab the archive that matches your OS and architecture.

## Platform Notes

| Platform         | Backend   | Notes                                     |
| ---------------- | --------- | ----------------------------------------- |
| Linux            | io\_uring | Best throughput                           |
| macOS            | kqueue    | Full feature support                      |
| Windows          | IOCP      | Unicode terminal recommended              |
| Android (Termux) | epoll     | Auto-discovery works on most home routers |