Files
openhuman/docs/install.md
T
YellowSnnowmannandGitHub 6406ec2bc3 Feat:package manager channels (brew, apt, npm ) (#166)
* feat(release): upload versioned CLI tarballs in release workflow (#128)

Package and upload non-Windows CLI tarballs with SHA-256 checksum companions during release builds so package managers can consume stable release artifacts.

Made-with: Cursor

* feat(packaging): add brew apt npm release channels automation (#128)

Add post-release workflow and channel assets to publish Homebrew formula updates, signed apt repository metadata, and npm package releases with smoke validation.

Made-with: Cursor

* docs: add installation guide for OpenHuman across various package managers
2026-04-01 19:30:55 +05:30

5.1 KiB

Installing OpenHuman

Quick install

Package manager Command OS
Homebrew brew install tinyhumansai/openhuman/openhuman macOS, Linux
apt sudo apt install openhuman (see setup) Debian, Ubuntu
npm npm install -g openhuman Any (Node ≥ 18)
curl curl -fsSL https://raw.githubusercontent.com/tinyhumansai/openhuman/main/scripts/install.sh | bash macOS, Linux

Homebrew (macOS / Linux)

brew install tinyhumansai/openhuman/openhuman

Update:

brew upgrade openhuman

Uninstall:

brew uninstall openhuman
brew untap tinyhumansai/openhuman   # optional: remove tap

Homebrew installs the binary as openhuman. The tap lives at tinyhumansai/homebrew-openhuman.


apt (Debian / Ubuntu)

1. Add the repository key and source

sudo apt-get install -y gnupg2 curl ca-certificates

curl -fsSL https://tinyhumansai.github.io/openhuman/apt/KEY.gpg \
  | sudo gpg --dearmor -o /etc/apt/keyrings/openhuman.gpg

echo "deb [signed-by=/etc/apt/keyrings/openhuman.gpg arch=amd64] \
  https://tinyhumansai.github.io/openhuman/apt stable main" \
  | sudo tee /etc/apt/sources.list.d/openhuman.list

arm64: replace arch=amd64 with arch=arm64 or arch=amd64,arm64.

2. Install

sudo apt-get update
sudo apt-get install openhuman

Update:

sudo apt-get update && sudo apt-get upgrade openhuman

Uninstall:

sudo apt-get remove openhuman
# remove repository (optional):
sudo rm /etc/apt/sources.list.d/openhuman.list /etc/apt/keyrings/openhuman.gpg

npm

npm install -g openhuman

Update:

npm update -g openhuman

Uninstall:

npm uninstall -g openhuman

The npm package is a thin wrapper that downloads the platform-native binary on first install and verifies its SHA-256 checksum before placing it. Node.js ≥ 18 is required; the binary itself has no Node dependency at runtime.


curl / manual install

curl -fsSL \
  https://raw.githubusercontent.com/tinyhumansai/openhuman/main/scripts/install.sh \
  | bash

Pass --dry-run to preview actions without installing:

bash scripts/install.sh --dry-run --verbose

Uninstall (manual):

rm "$(which openhuman)"

Support policy

Channel Tier Maintained by
Homebrew Official Core team
apt Official Core team
npm Official Core team
curl / install.sh Official Core team
AUR (Arch) Community Community PRs
Nix Community Community PRs
Scoop (Windows) Planned
Snap / Flatpak Planned

See tinyhumansai/openhuman#distribution-backlog for the next channels in the pipeline.


Troubleshooting

macOS Gatekeeper warning

If macOS blocks the binary with "cannot be opened because the developer cannot be verified":

# Option 1: approve via System Settings → Privacy & Security → Allow Anyway
# Option 2: remove quarantine flag (Homebrew install should handle this automatically)
xattr -d com.apple.quarantine "$(which openhuman)"

Binaries installed via Homebrew or the signed .app bundle are notarized by Apple and should not trigger Gatekeeper.

apt: "NO_PUBKEY" error

Re-import the key:

curl -fsSL https://tinyhumansai.github.io/openhuman/apt/KEY.gpg \
  | sudo gpg --dearmor -o /etc/apt/keyrings/openhuman.gpg
sudo apt-get update

npm: binary not found after install

The postinstall script may have failed silently. Re-run it manually:

FORCE_REINSTALL=1 node "$(npm root -g)/openhuman/install.js"

Or reinstall cleanly:

npm uninstall -g openhuman && npm install -g openhuman

Verify checksum manually

Every release asset ships a companion .sha256 file:

VERSION=0.49.33
TARGET=x86_64-unknown-linux-gnu
curl -fsSLO "https://github.com/tinyhumansai/openhuman/releases/download/v${VERSION}/openhuman-core-${VERSION}-${TARGET}.tar.gz"
curl -fsSLO "https://github.com/tinyhumansai/openhuman/releases/download/v${VERSION}/openhuman-core-${VERSION}-${TARGET}.tar.gz.sha256"
echo "$(cat openhuman-core-${VERSION}-${TARGET}.tar.gz.sha256)  openhuman-core-${VERSION}-${TARGET}.tar.gz" | sha256sum --check

Release artifacts reference

Each release attaches the following files:

Artifact Platform
openhuman-core-<v>-aarch64-apple-darwin.tar.gz macOS Apple Silicon
openhuman-core-<v>-x86_64-apple-darwin.tar.gz macOS Intel
openhuman-core-<v>-x86_64-unknown-linux-gnu.tar.gz Linux x86-64
openhuman-core-<v>-aarch64-unknown-linux-gnu.tar.gz Linux arm64
OpenHuman_<v>_aarch64.dmg macOS desktop app (Apple Silicon)
OpenHuman_<v>_x64.dmg macOS desktop app (Intel)
OpenHuman_<v>_amd64.deb Linux desktop app (.deb)
OpenHuman_<v>_amd64.AppImage Linux desktop app (AppImage)

Every archive has a corresponding .sha256 companion file.