Bitbucket Backup

 

logo

Bitbucket Backup is a backup tool which clones/pulls all your Bitbucket repositories to your local machine.


Links


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.


Setup

System requirements:

  • Windows (at least XP)
  • .NET Framework 4 Client Profile (of course it works with the full framework as well, but Client Profile is enough)
  • Mercurial (any version) if you have Mercurial repositories
  • Git (at least version 1.7.x) if you have Git repositories

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)

To install Bitbucket Backup on your machine, just run the setup.
When you run Bitbucket Backup the first time, it will ask you for:

  1. Your Bitbucket username and password
    This user's repositories will be backed up.

  2. Your Bitbucket team name (optional)
    If entered, the repositories of that team will be backed up instead of the user's repositories.
    The user is still needed for authentication.

  3. A backup folder on your local machine
    The folder must already exist, Bitbucket Backup won't create it!

  4. Timeout for pulling (optional, Mercurial only)
    By default, Mercurial times out after 60 seconds. You may want to increase that value if you have large repositories or a slow connection.

After that, Bitbucket Backup will run without user interaction, but you can re-enter your data any time by pressing SPACE on startup.


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:


Contributors


License

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


Project Info