Install

For the current preview, GitHub Release binaries are the primary binary source. npm and Homebrew are convenience channels, and source builds are for development or source inspection.

GitHub Release binaries

Download the macOS Apple Silicon or Intel asset from the current preview release, then verify the binary runs on your machine.

open https://github.com/OpenKeyring/oak-keyring/releases/tag/v0.8.0-preview.1 ok --version

Preview binaries are unsigned and not notarized. macOS Gatekeeper may require explicit user approval before first launch.

npm wrapper

The npm package is a convenience wrapper around the bundled Oak Keyring binary.

npm install -g @openkeyring/ok ok --version

Homebrew

Install via the Homebrew tap. Homebrew 6.0.0 and later require non-official taps to be trusted before their formulae can be loaded; this affects macOS and Linux.

brew tap openkeyring/oak-keyring brew trust --formula openkeyring/oak-keyring/ok brew install ok

If you skip brew trust, install fails with "Refusing to load formula ... from untrusted tap". A one-liner alternative is brew install openkeyring/oak-keyring/ok, which trusts only the ok formula.

Source build

Build from source when you want to inspect or modify the project. If you need Google Drive sync in a source build, configure OAuth2 values explicitly before building.

git clone https://github.com/OpenKeyring/oak-keyring.git cd oak-keyring cp .env.example .env # Set OAK_GOOGLE_CLIENT_ID and OAK_GOOGLE_CLIENT_SECRET. cargo build --release ./target/release/ok --version