RBW(1)

NAME
rbw - unofficial command line client for Bitwarden

SYNOPSIS
rbw command [options]

DESCRIPTION
rbw is an unofficial command line client for Bitwarden. It runs a background agent (rbw-agent) that keeps the decrypted vault in memory, so you do not need to enter your master password for every operation. The agent behaves similarly to ssh-agent(1) or gpg-agent(1).

COMMANDS

  Account Management

register
    Register this device with the Bitwarden server. Required before the first login when using the official Bitwarden server, to avoid bot detection. Use your personal API key credentials.

login
    Log in to the Bitwarden server.

unlock
    Unlock the local Bitwarden database.

unlocked
    Check if the local Bitwarden database is currently unlocked.

lock
    Lock the password database.

sync
    Update the local copy of the Bitwarden database from the server.

purge
    Remove the local copy of the password database.

stop-agent
    Terminate the background agent.

  Viewing Entries

list [--fields fields]
    List all entries in the local Bitwarden database. --fields accepts a comma-separated list of id, name, user, folder, type. Default: name. Alias: ls.

get name [user]
    Display the password for the given entry. [--field field] prints a specific field instead of the password. [--full] also prints the notes. Alias: show.

search term
    Search for entries whose name, username, or URI matches term.

code name [user]
    Display the current TOTP authenticator code for the given entry. Alias: totp.

history name [user]
    View the password history for the given entry.

  Modifying Entries

add name [user]
    Add a new password entry. Opens $VISUAL or $EDITOR to enter the password and notes. The first line is saved as the password; the rest as notes.

generate len [name [user]]
    Generate a new random password of length len. If name is given, saves the password to the database. [--no-symbols] generates without special characters. [--only-numbers] generates a numeric password. [--nonconfusables] avoids visually similar characters. [--diceware] generates a passphrase of len words from the EFF word list. Alias: gen.

edit name [user]
    Modify an existing entry. Opens $VISUAL or $EDITOR with the current password and notes.

remove name [user]
    Remove an entry from the database. Alias: rm.

  Configuration

config show
    Display all current configuration settings.

config set key value
    Set a configuration option. Valid keys are:
    email
        Bitwarden account email address.
    base_url
        Base URL for a self-hosted Bitwarden server.
    identity_url
        Identity service URL (overrides base_url).
    ui_url
        Web vault UI URL (overrides base_url).
    notifications_url
        Notifications service URL (overrides base_url).
    lock_timeout
        Seconds of inactivity before the agent locks the vault. Default: 3600.
    sync_interval
        Seconds between automatic syncs. Default: 3600. Set to 0 to disable.
    pinentry
        Pinentry program to use for password prompts. Default: pinentry.
    client_cert_path
        Path to a PEM client certificate for mutual TLS.

  Shell Completions

gen-completions shell
    Print a shell completion script to stdout. Supported shells: bash, zsh, fish, powershell, elvish, nushell, fig.

ENVIRONMENT

VISUAL, EDITOR
    Editor used by add and edit commands.

RBW_AGENT
    Path to a custom rbw-agent(1) binary.

FILES

$XDG_CONFIG_HOME/rbw/config.json
    Configuration file. Defaults to ~/.config/rbw/config.json.

$XDG_DATA_HOME/rbw/
    Vault data and device identifier. Defaults to ~/.local/share/rbw/.

$XDG_RUNTIME_DIR/rbw/
    Agent socket and PID file.

EXAMPLES
Log in and unlock the vault:
    $ rbw login
    $ rbw unlock

List all entries:
    $ rbw list

Get the password for an entry:
    $ rbw get github.com

Get the password for a specific user:
    $ rbw get github.com myuser

Add a new entry:
    $ rbw add github.com myuser

Generate and store a 20-character password:
    $ rbw generate 20 github.com myuser

Get a TOTP code:
    $ rbw code github.com

Use a self-hosted server:
    $ rbw config set base_url https://bitwarden.example.com

SEE ALSO
rbw-agent(1), pinentry(1), gpg-agent(1), ssh-agent(1)

AUTHORS
-nosplit rbw was written by Jesse Luehrs <doy@tozt.net>.

This manual page was written by Nadzeya Hutsko <nadzya.info@gmail.com>.