oak-keyring

(★ 231)

A privacy-first, local-first password manager with cross-platform synchronization.

File Explorer

Download Latest Version (.zip)

- audit.toml
- - bug_report.yml
  - installation_problem.yml
- - ci.yml
  - release.yml
- demo.gif
- dump_validation_harness.rs
- screenshot.png
- sqlcipher_bench.rs
- en.yml
- zh-CN.yml
- - package.json
  - README.md
- - package.json
  - README.md
- - package.json
  - README.md
- - package.json
  - README.md
- - package.json
  - README.md
- check-binary.js
- stage-binaries.sh
- package-preview.sh
- - cli.rs
  - identity.rs
  - lock.rs
  - mod.rs
  - paths.rs
  - server.rs
  - signer.rs
- - mod.rs
  - signal.rs
  - update.rs
  - view.rs
- - AGENTS.md
  - CLAUDE.md
  - credentials.rs
  - INSTRUCTIONS.md
  - metadata.rs
  - mod.rs
  - provider.rs
  - provider_test.rs
  - record.rs
  - schema.rs
  - storage.rs
  - validation.rs
- - command.rs
  - internal_command.rs
  - message.rs
  - mod.rs
  - result.rs
  - types.rs
- - config_test.rs
  - error.rs
  - general.rs
  - manager.rs
  - mod.rs
  - notification.rs
  - password.rs
  - security.rs
  - sync.rs
  - validation.rs
  - watcher.rs
- - argon2.rs
  - bip39.rs
  - crypto_manager.rs
  - db_page_key.rs
  - hkdf.rs
  - keystore.rs
  - mod.rs
  - password.rs
  - payload.rs
  - self_test.rs
  - strength.rs
  - xchacha20.rs
- - mod.rs
  - models.rs
  - models_test.rs
  - queries_test.rs
  - schema.rs
  - schema_test.rs
  - sqlcipher.rs
  - vault_db.rs
- - code.rs
  - context.rs
  - level.rs
  - mod.rs
  - service_error.rs
- - builder.rs
  - clipboard.rs
  - clipboard_test.rs
  - config.rs
  - execute.rs
  - health.rs
  - health_test.rs
  - import_export.rs
  - mock_orchestration_test.rs
  - mod.rs
  - record.rs
  - rotation.rs
  - runtime.rs
  - sync.rs
  - sync_test.rs
  - timer.rs
  - timer_test.rs
  - vault.rs
  - vault_test.rs
- - crash_handler.rs
  - crash_handler_test.rs
  - mach_exception.rs
  - memory.rs
  - memory_test.rs
  - mod.rs
  - process.rs
  - redaction.rs
- - clipboard.rs
  - health.rs
  - mod.rs
  - rotation.rs
  - sync.rs
- - AGENTS.md
  - checkpoint.rs
  - CLAUDE.md
  - conflict.rs
  - INSTRUCTIONS.md
  - lock.rs
  - mod.rs
  - nonce_validator.rs
  - pipeline.rs
  - pipeline_test.rs
  - retry.rs
  - state_machine.rs
  - task.rs
  - watcher.rs
- - AGENTS.md
  - CLAUDE.md
  - INSTRUCTIONS.md
  - mod.rs
  - terminal.rs
  - theme.rs
  - time.rs
- - audit.rs
  - audit_test.rs
  - credential.rs
  - credential_test.rs
  - health.rs
  - history.rs
  - mod.rs
  - record.rs
  - record_limits.rs
  - recovery_words.rs
  - rotation.rs
  - sensitive.rs
  - sync.rs
  - tag.rs
- instance_lock.rs
- lib.rs
- logging.rs
- main.rs
- paths.rs
- - 1PasswordExport.1pux
  - bitwarden_encrypted_argon2id_export.json
  - bitwarden_encrypted_export.json
  - bitwarden_export.json
  - bitwarden_nested_export.json
  - bitwarden_passkey_export.json
  - BrokenHeaderHash.kdbx
  - Compressed.kdbx
  - FileKeyBinary.kdbx
  - FileKeyHashed.kdbx
  - FileKeyHex.kdbx
  - FileKeyXml.kdbx
  - FileKeyXmlBrokenBase64.kdbx
  - FileKeyXmlV2.kdbx
  - FileKeyXmlV2BrokenHex.kdbx
  - FileKeyXmlV2HashFail.kdbx
  - Format200.kdbx
  - Format300.kdbx
  - Format400.kdbx
  - KeyFileProtected.kdbx
  - KeyFileProtectedNoPassword.kdbx
  - MergeDatabase.kdbx
  - NewDatabase.kdbx
  - NewDatabase2.kdbx
  - NewDatabaseBrowser.kdbx
  - NewDatabaseMulti.kdbx
  - NonAscii.kdbx
  - okb_basic.okb
  - okb_corrupted_header.bin
  - okb_edge_cases.okb
  - okb_mixed_types.okb
  - okb_truncated.bin
  - okb_wrong_version.bin
  - ProtectedStrings.kdbx
  - protonpass_export.json
  - RecycleBinDisabled.kdbx
  - RecycleBinEmpty.kdbx
  - RecycleBinNotYetCreated.kdbx
  - RecycleBinWithData.kdbx
  - SyncDatabase.kdbx
  - SyncDatabaseDifferentPassword.kdbx
  - YubiKeyProtectedPasswords.kdbx
- - config_lifecycle_test.rs
  - main.rs
  - mod.rs
  - sync_lifecycle_test.rs
- - test_ecdsa_256
  - test_ecdsa_256.pub
  - test_ecdsa_384
  - test_ecdsa_384.pub
  - test_ecdsa_384_encrypted
  - test_ecdsa_384_encrypted.pub
  - test_ecdsa_521
  - test_ecdsa_521.pub
  - test_ed25519
  - test_ed25519.pub
  - test_ed25519_encrypted
  - test_ed25519_encrypted.pub
  - test_rsa
  - test_rsa.pub
  - test_rsa_encrypted
  - test_rsa_encrypted.pub
- - audit_sync_test.rs
  - change_master_password_test.rs
  - clipboard_test.rs
  - db_lifecycle_test.rs
  - db_migration_test.rs
  - error_propagation_test.rs
  - executor_command_test.rs
  - executor_dispatch_test.rs
  - health_test.rs
  - i18n_test.rs
  - main.rs
  - main_pipeline_test.rs
  - okb_sample_file_test.rs
  - okb_serialization_roundtrip_test.rs
  - rotation_test.rs
  - smoke_test.rs
  - sqlcipher_poc_test.rs
  - sqlcipher_production_test.rs
  - ui_entry_test.rs
  - vault_db_crypto_test.rs
  - vault_service_test.rs
- - stage_binaries_test.sh
  - validate_dump_protection.sh
- - main.rs
- - main_integration_test__main_screen_renders_with_data.snap
- agent_e2e_test.rs
- agent_protocol_test.rs
- agent_shutdown_test.rs
- agent_signer_test.rs
- cli_version_test.rs
- instance_lock_test.rs
- mach_exception_integration_test.rs
- main_integration_test.rs
- memory_dump_protection_regression_test.rs
- sync_checkpoint_test.rs
- sync_conflict_test.rs
- sync_e2e_test.rs
- sync_health_closure_test.rs
- sync_pipeline_test.rs
- sync_private_metadata_test.rs
- sync_retry_test.rs
- - Cargo.lock
  - Cargo.toml
- - Cargo.lock
  - Cargo.toml
- - Cargo.lock
  - Cargo.toml
.env.example
.gitignore
.insta.toml
AGENTS.md
build.rs
Cargo.lock
Cargo.toml
CHANGELOG.md
CLAUDE.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
INSTALL-ZH.md
INSTALL.md
INSTRUCTIONS.md
justfile
LICENSE
PRIVACY.md
README-ZH.md
README.md
RELEASE.md
rust-analyzer.toml
rust-toolchain.toml
SECURITY.md
SUPPORT.md
THREAT_MODEL.md

# Installation Guide

1. Get the code

git clone https://github.com/OpenKeyring/oak-keyring

Downloads the entire project code from GitHub to your computer.

cd oak-keyring

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Homebrew A package manager for macOS/Linux.
Node.js Node.js must be installed to use npm.

brew tap openkeyring/oak-keyring

Registers this project's repository (tap) with Homebrew.

brew install ok

Installs the pre-built package via Homebrew — no source build required.

npm install -g @openkeyring/ok

Installs the package published on the npm registry globally — no need to clone the source.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install -g @openkeyring/ok

Installs the package published on the npm registry globally — no need to clone the source.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

4. Rust

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Rust (rustup) Installing via rustup also installs cargo.

cargo build --release

Compiles the Rust project.

✅ If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

oak-keyring

File Explorer

# Installation Guide

2. Official Install Script

3. Node.js

4. Rust

Today's picks

Was this content helpful?

Recent Feedback

oak-keyring

File Explorer

# Installation Guide

2. Official Install Script

3. Node.js

4. Rust

Today's picks

Was this content helpful?

Recent Feedback

Download README