Install from GitHub releases
The install script downloads the correct binary for your platform and places it on your PATH.
GITHUB_TOKEN is required when releases are hosted in a private repository. Use a token with repo read scope.
export GITHUB_TOKEN=<github-token-with-repo-read>
curl -fsSL -H "Authorization: Bearer ${GITHUB_TOKEN}" \
https://raw.githubusercontent.com/CEOofSaturdays/OpenIndex/main/scripts/install-oi.sh | bash
Install a specific version
Pin to a specific release tag:
curl -fsSL -H "Authorization: Bearer ${GITHUB_TOKEN}" \
https://raw.githubusercontent.com/CEOofSaturdays/OpenIndex/main/scripts/install-oi.sh | bash -s -- --tag v0.10.0
Install from stable releases only
Skip pre-release and release-candidate builds:
curl -fsSL -H "Authorization: Bearer ${GITHUB_TOKEN}" \
https://raw.githubusercontent.com/CEOofSaturdays/OpenIndex/main/scripts/install-oi.sh | bash -s -- --stable
Update an existing installation
Update the oi binary in place without re-running the install script:
Install with Homebrew
The Homebrew tap becomes available after a public tap release. If the tap is not yet published, use the GitHub release install method above.
brew tap openindex/tap
brew install oi
Build from source
You need Bun and Go installed. Clone the repository and run:
bun run build:cli
./bin/oi version
First-run setup
After installing, run the following commands to verify your environment and configure oi:
Check install prerequisites
Verify that all runtime dependencies are in place: Run guided setup
Initialize your first profile interactively: Diagnose your environment
Run a full health check across config, connectivity, and auth: