The Bitwarden desktop app is written using Electron and Angular. The application installs on Windows, macOS, and Linux distributions.
- Node.js v16.13.1 (LTS) or greater
- NPM v8
- Windows:
- To compile the native node modules used in the app you will need the Visual C++ toolset, available through the standard Visual Studio installer. You will also need to install the Microsoft Build Tools 2015 and Windows 10 SDK 17134 as additional dependencies in the Visual Studio installer.
- Linux:
- The following packages
build-essential libsecret-1-dev libglib2.0-dev
- The following packages
npm ci
npm run electron
Native Messaging (communication with the browser extension) works by having the browser start a lightweight proxy application baked into our desktop binary. To setup an environment which allows
for easy debugging you will need to build the application for distribution, i.e. npm run dist:<platform>
, start the dist version and enable desktop integration. This will write some manifests
to disk, Consult the native manifests documentation for more details of the manifest
format, and the exact locations for the different platforms. Note that disabling the desktop integration will delete the manifests, and the files will need to be updated again.
The generated manifests are pre-configured with the production ID for the browser extensions. In order to use them with the development builds, the browser extension ID of the development build
needs to be added to the allowed_extensions
section of the manifest. These IDs are generated by the browser, and can be found in the extension settings within the browser.
It will then be possible to run the desktop application as usual using npm run electron
and communicate with the browser.