Skip to content

A PowerShell script that automatically backups all remote GitHub repositories to a local directory.

License

Notifications You must be signed in to change notification settings

countzero/backup_github_repositories

Repository files navigation

Backup all git repositories from GitHub

A PowerShell script that automatically backups all GitHub repositories of a user or an organisation to a local directory as a bare Git repository.

Installation

Download and unpack the latest release to your machine.

Usage

Open a PowerShell console at the location of the unpacked release and execute the ./backup_github_repositories.ps1.

Examples

Backup all git repositories of a user

Execute the following to backup all git repositories of a GitHub user into the subdirectory ./YYYY-MM-DD/.

.\backup_github_repositories.ps1 -userName "user" -userSecret "token"

Backup all git repositores of a organisation

Execute the following to backup all git repositories of a GitHub organisation into the subdirectory ./YYYY-MM-DD/.

.\backup_github_repositories.ps1 -userName "user" -userSecret "token" -organisationName "organisation"

Backup all git repositories of a user into a specific directory

Execute the following to backup all git repositories of a GitHub user into the directory C:\myBackupDirectory and let the script prompt for the user secret.

.\backup_github_repositories.ps1 -userName "user" -backupDirectory "C:\myBackupDirectory"

Backup all git repositories with a maximum concurrency of 2

Execute the following to backup all git repositories of a GitHub user into the subdirectory ./YYYY-MM-DD/ with a maximum concurrency of 2 background jobs.

.\backup_github_repositories.ps1 -userName "user" -backupDirectory "C:\myBackupDirectory" -maxConcurrency 2

Get detailed help

Execute the following command to get detailed help.

Get-Help .\backup_github_repositories.ps1 -detailed

Frequently Asked Questions

How do I work with a bare repository?

A bare repository only consists of the history and is not intended to be used directly. If you want to work on a specific repository you must first convert it into a non-bare Git repository. That will give you the working tree of a specific branch.

Execute the following to clone the bare Git repository .\my_project.git into a non-bare Git repository .\my_project:

git clone .\my_project.git

About

A PowerShell script that automatically backups all remote GitHub repositories to a local directory.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published