Bitbucket Backup / readme-full.md

logo

Bitbucket Backup is a backup tool which backups all your Bitbucket repositories to your local machine.



How does it work?

Bitbucket Backup uses the Bitbucket API to get a list of all your repositories.
Then, it uses Mercurial and/or Git (which need to be installed on your machine if you have at least one repository of the given type) to clone every repository into your local backup folder (or just pull the newest changes if it already is in your local backup folder).
It also checks for each repository, whether it has a wiki (which is a repository itself). If yes, that will be automatically cloned/pulled as well.

DISCLAIMER: Git support is still very unstable.
For now, it works on my machine with Git 1.7.7 (but not on another machine with Git v1.6.5.1, for example). It definitely needs improvement.


Setup

Bitbucket Backup is a Windows application and requires the .NET Framework 4.0 (Client Profile is enough, no need for the full framework).
You can download the .NET Framework 4 Client Profile here.

To install Bitbucket Backup on your machine, just run the setup.
When you run Bitbucket Backup the first time, it will ask you for your Bitbucket username and password, and for the backup folder (must be an existing folder on your local machine).
After that, Bitbucket Backup will run without user interaction, but you can re-enter your data any time by pressing SPACE on startup.

Please note that Bitbucket Backup assumes that you have the Mercurial and Git executables in your %PATH% variable.
(depending on the version, Git may come with a git.exe AND a git.cmd - it doesn't matter which one is in the %PATH%, Bitbucket Backup will find both)


How to build

To create a release build, just run build.bat or build-setup.bat in the main folder.

  • build.bat will create a new folder named release\bin with the compiled exe and all necessary files.
  • build-setup.bat will do the same, and create a release\msi folder with a MSI setup.

Please note that WiX needs to be installed on your machine in order to build the setup file. We are using WiX 3.5 at the moment, which you can download here.
The build script assumes that the bin subfolder of the WiX installation folder is in your %PATH% variable.


Acknowledgements

Bitbucket Backup makes use of the following open source projects:

The logo is based on a floppy icon from Wikimedia Commons.


License

Bitbucket Backup is licensed under the MIT License. See License.rtf for details.

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.