Contribute

Source, issues, and contribution paths.

Oak Keyring is open source under the OpenKeyring organization. Contributions should respect the preview boundary, the local-first security model, and the project's secret-handling rules.

Before opening an issue

Use GitHub Issues for reproducible bugs, install failures, crashes, and documentation problems. Include the ok --version output, macOS version, Mac architecture, and whether the issue involves a new vault, restored vault, imported data, or synced data.

Use GitHub Discussions for usage questions, early feedback, and troubleshooting that may not be a product bug.

Secret handling

Never post real passwords, vault databases, recovery words, OAuth client secrets, OAuth tokens, private keys, or full logs containing sensitive values. If a reproduction needs data, create a disposable vault with fake records and fake credentials.

Build from source

Source builds are useful for inspection and development. Google Drive sync builds require OAuth2 values to be configured explicitly; development-only checks that do not exercise sync can use placeholder OAuth values.