diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 43 |
1 files changed, 39 insertions, 4 deletions
@@ -23,8 +23,8 @@ and merge pull requests implementing those features. ### Arch Linux -`rbw` is available in the [community -repository](https://archlinux.org/packages/community/x86_64/rbw/). +`rbw` is available in the [extra +repository](https://archlinux.org/packages/extra/x86_64/rbw/). Alternatively, you can install [`rbw-git`](https://aur.archlinux.org/packages/rbw-git/) from the AUR, which will always build from the latest master commit. @@ -37,10 +37,25 @@ You can download a Debian package from [`minisign`](https://github.com/jedisct1/minisign), and can be verified using the public key `RWTM0AZ5RpROOfAIWx1HvYQ6pw1+FKwN6526UFTKNImP/Hz3ynCFst3r`. +### Homebrew + +`rbw` is available in the [Homebrew repository](https://formulae.brew.sh/formula/rbw). You can install it via `brew install rbw`. + +### Nix + +`rbw` is available in the +[NixOS repository](https://search.nixos.org/packages?show=rbw). You can try +it out via `nix-shell -p rbw`. + +### Alpine + +`rbw` is available in the [testing repository](https://pkgs.alpinelinux.org/packages?name=rbw). +If you are not using the `edge` version of alpine you have to [enable the repository manually](https://wiki.alpinelinux.org/wiki/Repositories#Testing). + ### Other With a working Rust installation, `rbw` can be installed via `cargo install -rbw`. This requires that the +--locked rbw`. This requires that the [`pinentry`](https://www.gnupg.org/related_software/pinentry/index.en.html) program is installed (to display password prompts). @@ -56,13 +71,27 @@ configuration options: * `identity_url`: The URL of the Bitwarden identity server to use. If unset, will use the `/identity` path on the configured `base_url`, or `https://identity.bitwarden.com/` if no `base_url` is set. +* `notifications_url`: The URL of the Bitwarden notifications server to use. + If unset, will use the `/notifications` path on the configured `base_url`, + or `https://notifications.bitwarden.com/` if no `base_url` is set. * `lock_timeout`: The number of seconds to keep the master keys in memory for before requiring the password to be entered again. Defaults to `3600` (one hour). +* `sync_interval`: `rbw` will automatically sync the database from the server + at an interval of this many seconds, while the agent is running. Setting + this value to `0` disables this behavior. Defaults to `3600` (one hour). * `pinentry`: The [pinentry](https://www.gnupg.org/related_software/pinentry/index.html) executable to use. Defaults to `pinentry`. +### Profiles + +`rbw` supports different configuration profiles, which can be switched +between by using the `RBW_PROFILE` environment variable. Setting it to a name +(for example, `RBW_PROFILE=work` or `RBW_PROFILE=personal`) can be used to +switch between several different vaults - each will use its own separate +configuration, local vault, and agent. + ## Usage Commands can generally be used directly, and will handle logging in or @@ -82,7 +111,11 @@ out by running `rbw purge`, and you can explicitly lock the database by running functionality. Run `rbw get <name>` to get your passwords. If you also want to get the username -or the note associated, you can use the flag `--full`. +or the note associated, you can use the flag `--full`. You can also use the flag +`--field={field}` to get whatever default or custom field you want. The `--raw` +flag will show the output as JSON. In addition to matching against the name, +you can pass a UUID as the name to search for the entry with that id, or a +URL to search for an entry with a matching website entry. *Note to users of the official Bitwarden server (at bitwarden.com)*: The official server has a tendency to detect command line traffic as bot traffic @@ -95,3 +128,5 @@ the instructions [here](https://bitwarden.com/help/article/personal-api-key/). ## Related projects * [rofi-rbw](https://github.com/fdw/rofi-rbw): A rofi frontend for Bitwarden +* [bw-ssh](https://framagit.org/Glandos/bw-ssh/): Manage SSH key passphrases in Bitwarden +* [rbw-menu](https://github.com/rbuchberger/rbw-menu): Tiny menu picker for rbw |