Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/countzero/backup_github_repositories

A PowerShell script that automatically backups all remote GitHub repositories to a local directory.
https://github.com/countzero/backup_github_repositories

backup github powershell

Last synced: about 1 month ago
JSON representation

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

Awesome Lists containing this project

README

        

# 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](https://github.com/countzero/backup_github_repositories/releases/latest) to your machine.

## Usage
Open a PowerShell console at the location of the unpacked release and execute the [./backup_github_repositories.ps1](https://github.com/countzero/backup_github_repositories/blob/master/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/`.
```PowerShell
.\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/`.
```PowerShell
.\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.
```PowerShell
.\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.
```PowerShell
.\backup_github_repositories.ps1 -userName "user" -backupDirectory "C:\myBackupDirectory" -maxConcurrency 2
```

### Get detailed help
Execute the following command to get detailed help.
```PowerShell
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`:
```Shell
git clone .\my_project.git
```