Skip to content

Installation

Requirements

Operating Systems

OSStatus
macOS✅ Supported
Linux✅ Supported
Windows🚧 Planned

Dependencies

Bitwarden CLI (bw) is required. Install it first:

bash
# macOS
brew install bitwarden-cli

# Linux (Snap)
sudo snap install bw

# npm (cross-platform)
npm install -g @bitwarden/cli

See the official Bitwarden CLI docs for more options.

Install bwsf

macOS

bash
brew tap b4m-oss/tap && brew install bwsf

Linux

TIP

Linux requires Homebrew on Linux to be installed first.

bash
brew tap b4m-oss/tap && brew install bwsf

Verify Installation

bash
bwsf -v
# bwsf version x.x.x

Initial Setup

After installation, run the setup command to configure your Bitwarden connection:

bash
bwsf setup

You'll be prompted to enter:

  1. Your Bitwarden server URL (leave blank for Bitwarden Cloud)
  2. Your Bitwarden email
  3. Your master password

Uninstall

bash
brew uninstall bwsf

Upgrading

bash
brew upgrade bwsf

Released under the MIT License.