Reconcile Gitea distribution with current alpha behavior and release tooling

Hop-State: A_06FN55REVAR7VQG4BWJBCD8 Hop-Proposal: R_06FN55QTEWKH16NSR59YJYG Hop-Task: T_06FN3MBF98GWD4NA5PA1RWG Hop-Attempt: AT_06FN55BQ80H2S8WHNDD24G0
2026-07-11 12:10:59 -07:00
parent 23a4891099
commit de99aad4d4
28 changed files with 1565 additions and 21 deletions
@@ -0,0 +1,99 @@
+# Installation
+
+Packaged binaries are the recommended installation. They need Git 2.40 or
+newer; they do not need a local Go toolchain.
+
+## macOS and Linux
+
+```bash
+curl -fsSL https://githop.xyz/hop/hop/raw/branch/main/scripts/install.sh | sh
+```
+
+The installer:
+
+1. detects macOS/Linux and `amd64`/`arm64`;
+2. downloads the matching archive from the latest Gitea Release;
+3. downloads `checksums.txt` and verifies SHA-256 before extraction;
+4. installs the CLI to `~/.local/bin/hop`;
+5. adds `~/.local/bin` to `.zprofile` or `.profile` when necessary; and
+6. runs `hop skill install --force` for Codex.
+
+Review before execution:
+
+```bash
+curl -fsSLO https://githop.xyz/hop/hop/raw/branch/main/scripts/install.sh
+less install.sh
+sh install.sh
+```
+
+Installer options are environment variables:
+
+| Variable | Default | Purpose |
+|---|---|---|
+| `HOP_VERSION` | `latest` | Release tag such as `v0.1.0` |
+| `HOP_INSTALL_DIR` | `~/.local/bin` | Binary destination |
+| `HOP_INSTALL_SKILL` | `1` | Set to `0` to skip Codex skill installation |
+| `HOP_MODIFY_PATH` | `1` | Set to `0` to leave shell profiles unchanged |
+| `HOP_GITEA_URL` | `https://githop.xyz` | Gitea instance base URL |
+| `HOP_REPOSITORY` | `hop/hop` | Alternate Gitea owner/repository |
+
+Example:
+
+```bash
+HOP_VERSION=v0.1.0 HOP_INSTALL_DIR="$HOME/bin" sh install.sh
+```
+
+## Windows
+
+In PowerShell as your normal user:
+
+```powershell
+irm https://githop.xyz/hop/hop/raw/branch/main/scripts/install.ps1 | iex
+```
+
+The script verifies the Windows archive, installs to
+`%LOCALAPPDATA%\Programs\Hop`, updates the user PATH, and installs the Codex
+skill. To pin a version after downloading the script:
+
+```powershell
+.\install.ps1 -Version v0.1.0
+```
+
+Use `-SkipSkill` only when another agent runtime will receive the skill. Use
+`-SkipPath` when another tool manages your PATH.
+
+## Go install
+
+With Go 1.26 or newer:
+
+```bash
+go install githop.xyz/hop/hop/cmd/hop@latest
+hop skill install --force
+```
+
+Put `$(go env GOPATH)/bin` on PATH if `hop` is not found.
+
+## Build from source
+
+```bash
+git clone https://githop.xyz/hop/hop.git
+cd hop
+go test ./...
+go build -trimpath -o hop ./cmd/hop
+mkdir -p "$HOME/.local/bin"
+install -m 755 hop "$HOME/.local/bin/hop"
+"$HOME/.local/bin/hop" skill install --force
+```
+
+Source builds are intended for contributors and as a pre-release fallback.
+
+## Verify
+
+```bash
+hop version
+hop help
+git --version
+```
+
+If Codex Desktop was open during installation, restart it. See
+[Getting started](Getting-Started) next.