|
| 1 | +# Installing OpenHuman |
| 2 | + |
| 3 | +## Quick install |
| 4 | + |
| 5 | +| Package manager | Command | OS | |
| 6 | +|---|---|---| |
| 7 | +| **Homebrew** | `brew install tinyhumansai/openhuman/openhuman` | macOS, Linux | |
| 8 | +| **apt** | `sudo apt install openhuman` (see [setup](#apt-debianubuntu)) | Debian, Ubuntu | |
| 9 | +| **npm** | `npm install -g openhuman` | Any (Node ≥ 18) | |
| 10 | +| **curl** | `curl -fsSL https://raw.githubusercontent.com/tinyhumansai/openhuman/main/scripts/install.sh \| bash` | macOS, Linux | |
| 11 | + |
| 12 | +--- |
| 13 | + |
| 14 | +## Homebrew (macOS / Linux) |
| 15 | + |
| 16 | +```bash |
| 17 | +brew install tinyhumansai/openhuman/openhuman |
| 18 | +``` |
| 19 | + |
| 20 | +**Update:** |
| 21 | +```bash |
| 22 | +brew upgrade openhuman |
| 23 | +``` |
| 24 | + |
| 25 | +**Uninstall:** |
| 26 | +```bash |
| 27 | +brew uninstall openhuman |
| 28 | +brew untap tinyhumansai/openhuman # optional: remove tap |
| 29 | +``` |
| 30 | + |
| 31 | +Homebrew installs the binary as `openhuman`. The tap lives at |
| 32 | +[tinyhumansai/homebrew-openhuman](https://github.com/tinyhumansai/homebrew-openhuman). |
| 33 | + |
| 34 | +--- |
| 35 | + |
| 36 | +## apt (Debian / Ubuntu) |
| 37 | + |
| 38 | +### 1. Add the repository key and source |
| 39 | + |
| 40 | +```bash |
| 41 | +sudo apt-get install -y gnupg2 curl ca-certificates |
| 42 | + |
| 43 | +curl -fsSL https://tinyhumansai.github.io/openhuman/apt/KEY.gpg \ |
| 44 | + | sudo gpg --dearmor -o /etc/apt/keyrings/openhuman.gpg |
| 45 | + |
| 46 | +echo "deb [signed-by=/etc/apt/keyrings/openhuman.gpg arch=amd64] \ |
| 47 | + https://tinyhumansai.github.io/openhuman/apt stable main" \ |
| 48 | + | sudo tee /etc/apt/sources.list.d/openhuman.list |
| 49 | +``` |
| 50 | + |
| 51 | +> **arm64:** replace `arch=amd64` with `arch=arm64` or `arch=amd64,arm64`. |
| 52 | +
|
| 53 | +### 2. Install |
| 54 | + |
| 55 | +```bash |
| 56 | +sudo apt-get update |
| 57 | +sudo apt-get install openhuman |
| 58 | +``` |
| 59 | + |
| 60 | +**Update:** |
| 61 | +```bash |
| 62 | +sudo apt-get update && sudo apt-get upgrade openhuman |
| 63 | +``` |
| 64 | + |
| 65 | +**Uninstall:** |
| 66 | +```bash |
| 67 | +sudo apt-get remove openhuman |
| 68 | +# remove repository (optional): |
| 69 | +sudo rm /etc/apt/sources.list.d/openhuman.list /etc/apt/keyrings/openhuman.gpg |
| 70 | +``` |
| 71 | + |
| 72 | +--- |
| 73 | + |
| 74 | +## npm |
| 75 | + |
| 76 | +```bash |
| 77 | +npm install -g openhuman |
| 78 | +``` |
| 79 | + |
| 80 | +**Update:** |
| 81 | +```bash |
| 82 | +npm update -g openhuman |
| 83 | +``` |
| 84 | + |
| 85 | +**Uninstall:** |
| 86 | +```bash |
| 87 | +npm uninstall -g openhuman |
| 88 | +``` |
| 89 | + |
| 90 | +The npm package is a thin wrapper that downloads the platform-native binary on |
| 91 | +first install and verifies its SHA-256 checksum before placing it. Node.js ≥ 18 |
| 92 | +is required; the binary itself has no Node dependency at runtime. |
| 93 | + |
| 94 | +--- |
| 95 | + |
| 96 | +## curl / manual install |
| 97 | + |
| 98 | +```bash |
| 99 | +curl -fsSL \ |
| 100 | + https://raw.githubusercontent.com/tinyhumansai/openhuman/main/scripts/install.sh \ |
| 101 | + | bash |
| 102 | +``` |
| 103 | + |
| 104 | +Pass `--dry-run` to preview actions without installing: |
| 105 | + |
| 106 | +```bash |
| 107 | +bash scripts/install.sh --dry-run --verbose |
| 108 | +``` |
| 109 | + |
| 110 | +**Uninstall (manual):** |
| 111 | +```bash |
| 112 | +rm "$(which openhuman)" |
| 113 | +``` |
| 114 | + |
| 115 | +--- |
| 116 | + |
| 117 | +## Support policy |
| 118 | + |
| 119 | +| Channel | Tier | Maintained by | |
| 120 | +|---|---|---| |
| 121 | +| Homebrew | **Official** | Core team | |
| 122 | +| apt | **Official** | Core team | |
| 123 | +| npm | **Official** | Core team | |
| 124 | +| curl / install.sh | **Official** | Core team | |
| 125 | +| AUR (Arch) | Community | Community PRs | |
| 126 | +| Nix | Community | Community PRs | |
| 127 | +| Scoop (Windows) | Planned | — | |
| 128 | +| Snap / Flatpak | Planned | — | |
| 129 | + |
| 130 | +See [tinyhumansai/openhuman#distribution-backlog](https://github.com/tinyhumansai/openhuman/issues?q=label%3Adistribution-backlog) for the next channels in the pipeline. |
| 131 | + |
| 132 | +--- |
| 133 | + |
| 134 | +## Troubleshooting |
| 135 | + |
| 136 | +### macOS Gatekeeper warning |
| 137 | + |
| 138 | +If macOS blocks the binary with *"cannot be opened because the developer cannot be verified"*: |
| 139 | + |
| 140 | +```bash |
| 141 | +# Option 1: approve via System Settings → Privacy & Security → Allow Anyway |
| 142 | +# Option 2: remove quarantine flag (Homebrew install should handle this automatically) |
| 143 | +xattr -d com.apple.quarantine "$(which openhuman)" |
| 144 | +``` |
| 145 | + |
| 146 | +Binaries installed via Homebrew or the signed `.app` bundle are notarized by |
| 147 | +Apple and should not trigger Gatekeeper. |
| 148 | + |
| 149 | +### apt: "NO_PUBKEY" error |
| 150 | + |
| 151 | +Re-import the key: |
| 152 | +```bash |
| 153 | +curl -fsSL https://tinyhumansai.github.io/openhuman/apt/KEY.gpg \ |
| 154 | + | sudo gpg --dearmor -o /etc/apt/keyrings/openhuman.gpg |
| 155 | +sudo apt-get update |
| 156 | +``` |
| 157 | + |
| 158 | +### npm: binary not found after install |
| 159 | + |
| 160 | +The postinstall script may have failed silently. Re-run it manually: |
| 161 | +```bash |
| 162 | +FORCE_REINSTALL=1 node "$(npm root -g)/openhuman/install.js" |
| 163 | +``` |
| 164 | + |
| 165 | +Or reinstall cleanly: |
| 166 | +```bash |
| 167 | +npm uninstall -g openhuman && npm install -g openhuman |
| 168 | +``` |
| 169 | + |
| 170 | +### Verify checksum manually |
| 171 | + |
| 172 | +Every release asset ships a companion `.sha256` file: |
| 173 | + |
| 174 | +```bash |
| 175 | +VERSION=0.49.33 |
| 176 | +TARGET=x86_64-unknown-linux-gnu |
| 177 | +curl -fsSLO "https://github.com/tinyhumansai/openhuman/releases/download/v${VERSION}/openhuman-core-${VERSION}-${TARGET}.tar.gz" |
| 178 | +curl -fsSLO "https://github.com/tinyhumansai/openhuman/releases/download/v${VERSION}/openhuman-core-${VERSION}-${TARGET}.tar.gz.sha256" |
| 179 | +echo "$(cat openhuman-core-${VERSION}-${TARGET}.tar.gz.sha256) openhuman-core-${VERSION}-${TARGET}.tar.gz" | sha256sum --check |
| 180 | +``` |
| 181 | + |
| 182 | +--- |
| 183 | + |
| 184 | +## Release artifacts reference |
| 185 | + |
| 186 | +Each release attaches the following files: |
| 187 | + |
| 188 | +| Artifact | Platform | |
| 189 | +|---|---| |
| 190 | +| `openhuman-core-<v>-aarch64-apple-darwin.tar.gz` | macOS Apple Silicon | |
| 191 | +| `openhuman-core-<v>-x86_64-apple-darwin.tar.gz` | macOS Intel | |
| 192 | +| `openhuman-core-<v>-x86_64-unknown-linux-gnu.tar.gz` | Linux x86-64 | |
| 193 | +| `openhuman-core-<v>-aarch64-unknown-linux-gnu.tar.gz` | Linux arm64 | |
| 194 | +| `OpenHuman_<v>_aarch64.dmg` | macOS desktop app (Apple Silicon) | |
| 195 | +| `OpenHuman_<v>_x64.dmg` | macOS desktop app (Intel) | |
| 196 | +| `OpenHuman_<v>_amd64.deb` | Linux desktop app (.deb) | |
| 197 | +| `OpenHuman_<v>_amd64.AppImage` | Linux desktop app (AppImage) | |
| 198 | + |
| 199 | +Every archive has a corresponding `.sha256` companion file. |
0 commit comments