Password Manager CLI

The Bitwarden command-line interface (CLI) is a powerful, fully-featured tool for accessing and managing your vault. Most features that you find in other Bitwarden client applications (desktop, browser extension, etc.) are available from the CLI.

The Bitwarden CLI is self-documented. From the command line, learn about the available commands using:


bw --help

Or, pass --help as an option on any bw command to see available options and examples:


bw list --help

bw move --help

Most information you'll need can be accessed using --help, however this article replicates all that information and goes into greater depth on some topics.

The CLI can be used cross-platform on Windows, macOS, and Linux distributions. To download and install the Bitwarden CLI:


chmod +x </path/to/executable>


npm install -g @bitwarden/cli


choco install bitwarden-cli


sudo snap install bw

Before logging in, make sure your CLI is connected to the correct server (for example, EU cloud or self-hosted) using the config command (learn more). There are three methods for logging in to the Bitwarden CLI using the login command, each of which is suited to different situations. Please review the following options to determine which method to use:

• Using email and master password

• Using an API key

• Using SSO

No matter which option you use, always be sure to use the bw lock or bw logout commands when you're finished.

Logging in with email and password is recommended for interactive sessions. To log in with email and password:


bw login

This will initiate a prompt for your Email Address, Master Password, and (if enabled) at Two-step Login code. The CLI currently supports two-step login via authenticator, email, or Yubikey.

You can string these factors together into a single command as in the following example, however this isn't recommended for security reasons:


bw login [email] [password] --method <method> --code <code>

See Enums for two-step login <method> values.

Logging in with the personal API key is recommended for automated workflows, for providing access to an external application, or if your account uses a 2FA method not supported by the CLI (FIDO2 or Duo). To log in with the API key:


bw login --apikey

This will initiate a prompt for your personal client_id and client_secret. Once your session is authenticated using these values, you can use the unlock command. Learn more.

Using API key environment variables

In scenarios where automated work is being done with the Bitwarden CLI, you can save environment variables to prevent the need for manual intervention at authentication.

Logging in with SSO is recommended if an organization requires SSO authentication. To log in with SSO:


bw login --sso

This will initiate the SSO authentication flow in your web browser. Once your session is authenticated, you can use the unlock command. Learn more.

Like using account switching on other Bitwarden apps, the CLI has the ability to log in to multiple accounts simultaneously using the BITWARDENCLI_APPDATA_DIR environment variable pointing to the location of a bw configuration file, usually named data.json. You can, for example, set aliases in a .bashrc profile for two separate configurations:


alias bw-personal="BITWARDENCLI_APPDATA_DIR=~/.config/Bitwarden\ CLI\ Personal /path/to/bw $@"
alias bw-work="BITWARDENCLI_APPDATA_DIR=~/.config/Bitwarden\ CLI\ Work /path/to/bw $@"

Using this example, you could then use login to two accounts by running first source /path/to/.bashrc, followed by bw-personal login and bw-work login.

Using an API key or SSO to log in will require you to follow-up the login command with an explicit bw unlock if you'll be working with vault data directly.

Unlocking your vault generates a session key which acts as a decryption key used to interact with data in your vault. The session key must be used to perform any command that touches vault data (for example, list, get, edit). Session keys are valid until invalidated using bw lock or bw logout, however they will not persist if you open a new terminal window. Generate a new session key at any time using:


bw unlock

When you're finished, always end your session using the bw lock command.

You can use the --passwordenv <passwordenv> or --passwordfile <passwordfile> options with bw unlock to retrieve your master password rather than enter it manually, for example:

1. The following will look for an environment variable BW_PASSWORD. If BW_PASSWORD is non-empty and has correct values, the CLI will successfully unlock and return a session key:

   
   bw unlock --passwordenv BW_PASSWORD

2. The following will look for the file ~Users/Me/Documents/mp.txt (which must have your master password as the first line). If the file is non-empty and has a correct value, the CLI will successfully unlock and return a session key:

   
   bw unlock --passwordfile ~/Users/Me/Documents/mp.txt

When you unlock your vault using bw login with email and password or bw unlock, the CLI will return both an export BW_SESSION (Bash) and env:BW_SESSION (PowerShell) command, including your session key. Copy and paste the relevant entry to save the required environment variable.

With the BW_SESSION environment variable set, bw commands will reference that variable and can be run cleanly, for example:


export BW_SESSION="5PBYGU+5yt3RHcCjoeJKx/wByU34vokGRZjXpSH7Ylo8w=="

bw list items

Alternatively, if you don't set the environment variable, you can pass the session key as an option with each bw command:


bw list items --session "5PBYGU+5yt3RHcCjoeJKx/wByU34vokGRZjXpSH7Ylo8w=="

The create command creates a new object (item, attachment, and more) in your vault:


bw create (item|attachment|folder|org-collection) <encodedJson> [options]

The create command takes encoded JSON. A typical workflow for creating an object might look something like:

1. Use the get template command (see details) to output the appropriate JSON template for the object type.

2. Use a command-line JSON processor like jq to manipulate the outputted template as required.

3. Use the encode command (see details) to encode the manipulated JSON.

4. Use the create command to create an object from the encoded JSON.

For example:


bw get template folder | jq '.name="My First Folder"' | bw encode | bw create folder

or


bw get template item | jq ".name=\"My Login Item\" | .login=$(bw get template item.login | jq '.username="jdoe" | .password="myp@ssword123"')" | bw encode | bw create item

Upon successful creation, the newly created object will be returned as JSON.

create other item types

The create command defaults to creating a login item, but you can use a command-line JSON processor like jq to change a .type= attribute to create other item types:

For example, the following command will create a secure note:


bw get template item | jq '.type = 2 | .secureNote.type = 0 | .notes = "Contents of my Secure Note." | .name = "My Secure Note"' | bw encode | bw create item

create attachment

The create attachment command attaches a file to an existing item.

Unlike other create operations, you don’t need to use a JSON processor or encode to create an attachment. Instead, use the --file option to specify the file to attach and the --itemid option to specify the item to attach it to. For example:


bw create attachment --file ./path/to/file --itemid 16b15b89-65b3-4639-ad2a-95052a6d8f66

The get command retrieves a single object (item, username, password, and more) from your vault:


bw get (item|username|password|uri|totp|exposed|attachment|folder|collection|organization|org-collection|template|fingerprint) <id> [options]

The get command takes an item id or string for its argument. If you use a string (for example, anything other than an exact id), get will search your vault objects for one with a value that matches. For example, the following command would return a Github password:


bw get password Github

get attachment

The get attachment command downloads a file attachment:


bw get attachment <filename> --itemid <id>

The get attachment command takes a filename and exact id. By default, get attachment will download the attachment to the current working directory. You can use the --output option to specify a different output directory, for example:


bw get attachment photo.png --itemid 99ee88d2-6046-4ea7-92c2-acac464b1412 --output /Users/myaccount/Pictures/

get notes

The get notes command retrieves the note for any vault item:


bw get notes <id>

The get notes command takes an exact item id or string. If you use a string (for example, anything other than an exact id), get notes will search your vault objects for one with a value that matches. For example, the following command would return a Github note:


bw get notes Github

get template

The get template command returns the expected JSON formatting for an object (item, item.field, item.login, and more):


bw get template (item|item.field|item.login|item.login.uri|item.card|item.identity|item.securenote|folder|collection|item-collections|org-collection)

While you can use get template to output the format to your screen, the most common use-case is to pipe the output into a bw create operation, using a command-line JSON processor like jq and bw encode to manipulate the values retrieved from the template, for example:


bw get template folder | jq '.name="My First Folder"' | bw encode | bw create folder


bw get template item | jq ".name=\"My Login Item\" | .login=$(bw get template item.login | jq '.username="jdoe" | .password="myp@ssword123"')" | bw encode | bw create item

The edit command edits an object (item, item-collections, etc.) in your vault:


bw edit (item|item-collections|folder|org-collection) <id> [encodedJson] [options]

The edit command takes an exact id (the object to edit) and encoded JSON (edits to be made). A typical workflow might look something like:

1. Use the get command (see details) to output the object to edit.

2. Use a command-line JSON processor like jq to manipulate the outputted object as required.

3. Use the encode command (see details) to encode the manipulated JSON.

4. Use the edit command (including the object id) to edit the object.

For example, to edit the password of a login item:


bw get item 7ac9cae8-5067-4faf-b6ab-acfd00e2c328 | jq '.login.password="newp@ssw0rd"' | bw encode | bw edit item 7ac9cae8-5067-4faf-b6ab-acfd00e2c328

Or, to edit the collection(s) an item is in:


echo '["5c926f4f-de9c-449b-8d5f-aec1011c48f6"]' | bw encode | bw edit item-collections 28399a57-73a0-45a3-80f8-aec1011c48f6 --organizationid 4016326f-98b6-42ff-b9fc-ac63014988f5

Or, to edit a collection:


bw get org-collection ee9f9dc2-ec29-4b7f-9afb-aac8010631a1 --organizationid 4016326f-98b6-42ff-b9fc-ac63014988f5 | jq '.name="My Collection"' | bw encode | bw edit org-collection ee9f9dc2-ec29-4b7f-9afb-aac8010631a1 --organizationid 4016326f-98b6-42ff-b9fc-ac63014988f5

The edit command will perform a replace operation on the object. Once completed, the updated object will be returned as JSON.

The list command retrieves an array of objects (items, folders, collections, and more) from your vault:


bw list (items|folders|collections|organizations|org-collections|org-members) [options]

Options for the list command are filters used to dictate what will be returned, including --url <url>, --folderid <folderid>, --collectionid <collectionid>, --organizationid <organizationid> and --trash. Any filter will accept null or notnull. Combining multiple filters in one command will perform an OR operation, for example:


bw list items --folderid null --collectionid null

This command will return items that aren't in a folder or collection.

Additionally, you can search for specific objects using --search <search-term>. Combining filter and search in one command will perform an AND operation, for example:


bw list items --search github --folderid 9742101e-68b8-4a07-b5b1-9578b5f88e6f

This command will search for items with the string github in the specified folder.

The delete command deletes an object from your vault. delete takes only an exact id for its argument.


bw delete (item|attachment|folder|org-collection) <id> [options]

By default, delete will send an item to the Trash, where it will remain for 30 days. You can permanently delete an item using the -p, --permanent option.


bw delete item 7063feab-4b10-472e-b64c-785e2b870b92 --permanent

To delete an org-collection, you'll also need to specify --organizationid <organizationid>. See Organization IDs.

The restore command restores a deleted object from your trash. restore takes only an exact id for its argument.


bw restore (item) <id> [options]

For example:


bw restore item 7063feab-4b10-472e-b64c-785e2b870b92

The send command creates a Bitwarden Send object for ephemeral sharing. This section will detail simple send operations, however send is a highly flexible tool and we recommend referring to the dedicated article on Send from CLI.

To create a simple text Send:


bw send -n "My First Send" -d 7 --hidden "The contents of my first text Send."

To create a simple file Send:


bw send -n "A Sensitive File" -d 14 -f /Users/my_account/Documents/sensitive_file.pdf

The receive command accesses a Bitwarden Send object. To receive a Send object:


bw receive --password passwordforaccess https://vault.bitwarden.com/#/send/yawoill8rk6VM6zCATXv2A/9WN8wD-hzsDJjfnXLeNc2Q

Accessing an organization from the CLI requires knowledge of an ID for your organization, as well as IDs for individual members and collections.

Retrieve this information directly from the CLI using bw list, for example:


bw list organizations
bw list org-members --organizationid 4016326f-98b6-42ff-b9fc-ac63014988f5
bw list org-collections --organizationid 4016326f-98b6-42ff-b9fc-ac63014988f5

The move command transfers a vault item to an organization:


bw move <itemid> <organizationid> [encodedJson]

The move command requires you to encode a collection ID, and takes an exact id (the object to share) and an exact organizationid (the organization to share the object to). For example:


echo '["bq209461-4129-4b8d-b760-acd401474va2"]' | bw encode | bw move ed42f44c-f81f-48de-a123-ad01013132ca dfghbc921-04eb-43a7-84b1-ac74013bqb2e

Once completed, the updated item will be returned.

The confirm command confirms invited members to your organization who have accepted their invitation:


bw confirm org-member <id> --organizationid <orgid>

The confirm command takes an exact member id and an exact organizationID, for example:


bw confirm org-member 7063feab-4b10-472e-b64c-785e2b870b92 --organizationid 310d5ffd-e9a2-4451-af87-ea054dce0f78

The config command specifies settings for the Bitwarden CLI to use:


bw config server <setting> [value]

A primary use of bw config is to connect your CLI to a self-hosted Bitwarden server:


bw config server https://your.bw.domain.com


bw config server https://vault.bitwarden.eu

Users with unique setups may elect to specify the URL of each service independently. Note that any subsequent use of the config command will overwrite all previous specifications, so this must be run as a single command each time you make a change:


bw config server --web-vault <url> \
  --api <url> \
  --identity <url> \ 
  --icons <url> \
  --notifications <url> \
  --events <url> \
  --key-connector <url>

The sync command downloads your encrypted vault from the Bitwarden server. This command is most useful when you have changed something in your Bitwarden vault on another client application (for example web vault, browser extension, mobile app) since logging in on the CLI.


bw sync

You can pass the --last option to return only the timestamp (ISO 8601) of the last time a sync was performed.

The encode command Base 64 encodes stdin. This command is typically used in combination with a command-line JSON processor like jq when performing create and edit operations, for example:


bw get template folder | jq '.name="My First Folder"' | bw encode | bw create folder

bw get item 7ac9cae8-5067-4faf-b6ab-acfd00e2c328 | jq '.login.password="newp@ssw0rd"' | bw encode | bw edit item 7ac9cae8-5067-4faf-b6ab-acfd00e2c328

The import command imports data from a Bitwarden export or other supported password management application. The command must be pointed to a file and include the following arguments:


bw import <format> <path>

For example:


bw import lastpasscsv /Users/myaccount/Documents/mydata.csv

The export command exports vault data as a .json or .csv, or encrypted .json file:


bw export [--output <filePath>] [--format <format>] [--password <password>] [--organizationid <orgid>]

By default, the export command will generate a .csv (equivalent to specifying --format csv) to the current working directory, however you can specify:

• --format json to export a .json file

• --format encrypted_json to export an encrypted .json file

  • --password <password> to specify a password to use to encrypt encrypted_json exports instead of your account encryption key

• --output <path> to export to a specific location

• --raw to return the export to stdout instead of to a file

export from an organization vault

Using the export command with the --organizationid option, you can export an organization vault:


bw export --organizationid 7063feab-4b10-472e-b64c-785e2b870b92 --format json --output /Users/myaccount/Downloads/

The generate command generates a strong password or passphrase:


bw generate [--lowercase --uppercase --number --special --length <length> --passphrase --separator <separator> --words <words>]

By default, the generate command will generate a 14-character password with uppercase characters, lowercase characters, and numbers. This is the equivalent of passing:


bw generate -uln --length 14

You can generate more complex passwords using the options available to the command, including:

• --uppercase, -u (include uppercase)

• --lowercase, -l (include lowercase)

• --number, -n (include numbers)

• --special, -s (include special characters)

• --length <length> (length of the password, min of 5)

generate a passphrase

Using the generate command with the --passphrase option, you can generate a passphrase instead of a password:


bw generate --passphrase --words <words> --separator <separator>

By default, bw generate --passphrase will generate a three-word passphrase separated by a dash (-). This is the equivalent of passing:


bw generate --passphrase --words 3 --separator -

You can generate a complex passphrase using the options available to the command, including:

• --words <words> (number of words)

• --separator <separator> (separator character)

• --capitalize, -c (include to title-case the passphrase)

• --includeNumber (include numbers in the passphrase)

The update command checks whether your Bitwarden CLI is running the most recent version. update doesn't automatically update the CLI for you.


bw update

If a new version is detected, you'll need to download the new version of the CLI using the printed URL for the executable, or using the tools available for the package manager you used to download the CLI (for example, npm install -g @bitwarden/cli).

The status command returns status information about the Bitwarden CLI, including configured server URL, timestamp for the last sync (ISO 8601), user email and ID, and the vault status.


bw status

Status will return information as a JSON object, for example:


{
  "serverUrl": "https://bitwarden.example.com",
  "lastSync": "2020-06-16T06:33:51.419Z",
  "userEmail": "user@example.com",
  "userId": "00000000-0000-0000-0000-000000000000",
  "status": "unlocked"
}

status may be one of the following:

• "unlocked", indicating you are logged in and your vault is unlocked (a BW_SESSION key environment variable is saved with an active session key)

• "locked", indicating you are logged in but your vault is locked (no BW_SESSION key environment variable is saved with an active session key)

• "unauthenticated", indicating you aren't logged in

The serve command starts a local express web server that can be used to take all actions accessible from the CLI in the form of RESTful API calls from an HTTP interface.


bw serve --port <port> --hostname <hostname>

By default, serve will start the web server at port 8087 however you can specify an alternate port with the --port option.

By default, serve will bind your API web server to localhost however you can specify an alternate hostname with the --hostname option. API requests can only be made from the bound hostname.

By default, serve will block any request with an Origin header. You can circumvent this protection using the --disable-origin-protection option, however this is not recommended.

View the API spec for help making calls with serve.

The following options are available globally:

The Bitwarden CLI includes support for ZSH shell completion. To setup shell completion, use one of the following methods:

1. Vanilla ZSH: Add the following line to your .zshrc file:

   
   eval "$(bw completion --shell zsh); compdef _bw bw;"

2. Vanilla (vendor-completions): Run the following command:

   
   bw completion --shell zsh | sudo tee /usr/share/zsh/vendor-completions/_bw

3. zinit: Run the following commands:

   
   bw completion --shell zsh > ~/.local/share/zsh/completions/_bw
   zinit creinstall ~/.local/share/zsh/completions

If your self-hosted Bitwarden server exposes a self-signed TLS certificate, specify the Node.js environment variable NODE_EXTRA_CA_CERTS:

 Bash


export NODE_EXTRA_CA_CERTS="absolute/path/to/your/certificates.pem"

 PowerShell


$env:NODE_EXTRA_CA_CERTS="absolute/path/to/your/certificates.pem"

The following tables enumerate values required in documented scenarios:

Two-step login methods

Used to specify which two-step login method to use when logging in:

Item types

Used with the create command to specify a vault item type:

Login URI match types

Used with the create and edit command to specify URI match detection behavior for a login item:

Field types

Used with the create and edit commands to configure custom fields:

Organization user types

Indicates a user's type:

Organization user statuses

Indicates a user's status within the organization: