Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
trparky authored Dec 20, 2023
1 parent e43c719 commit e55d16f
Showing 1 changed file with 1 addition and 21 deletions.
22 changes: 1 addition & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,7 @@
# Bitwarden Vault Export Script
As stated in the script file, the script is based upon another (Bash) script created by "David H". I took his script, added much more functionality, and eventually converted it over to a Powershell script.

# Environment Setup
In order for this Powershell script to work and you know, export your Bitwarden Vault, you'll need the Bitwarden CLI executable. You can get it by going to https://bitwarden.com/download/ and scrolling down to the section that reads "Command Line Interface". In the case of this script, since it was built to run on Windows, you'll want to choose the Windows version.

Once you have the BW.EXE file, simply drop it into the same folder as you have this script.

**Note:** There's a possibility that this script *may* work on any operating system that Powershell can be installed on. So far, I've only tested on Ubuntu in WSL.

# Organization Configuration
$orgId, this is the variable that you need to set in order to export your organization data. In order to get your organization GUID, do the following...
bw.exe login
(follow the prompts)
bw.exe list organizations | ConvertFrom-Json | Select-Object -ExpandProperty Id

For example...
![image](https://github.com/trparky/Bitwarden-Vault-Export-Script/assets/32105035/8639888a-d1bd-4804-94bb-77dcd91499d7)

A GUID looks like this... 14fc2739-eb67-4e20-b39a-1c492e4fdaac

Copy that and put it into the $orgId variable and then execute ./bw_export.ps1 and follow the prompts.

That's all there is to it.
Starting with Version 1.17 it's even easier to use this script. The script does everything for you. All you have to do is run it, it will download the Bitwarden CLI program (if it needs to), and yes, it'll even fill in your $orgId by auto-discovering it for you. There's so many new improvements to the code from the original version that makes this script surpass the original script written by David H by leaps and bounds.

# Open Source!!!
Yes, this is open source and licensed under the MIT license. What does this mean? It means that you, the user, can fork this project, make your additions, and create a pull request for me to include your additions and improvements back to the original script. Isn't open source cool? I think so!

0 comments on commit e55d16f

Please sign in to comment.