https://github.com/antony/github-backup

Backup github organisations with a single command
https://github.com/antony/github-backup

backup backup-cli git github github-api github-backup github-client

Last synced: 3 months ago
JSON representation

Backup github organisations with a single command

• Host: GitHub
• URL: https://github.com/antony/github-backup
• Owner: antony
• Created: 2018-06-11T17:07:04.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-06-12T07:51:20.000Z (almost 7 years ago)
• Last Synced: 2025-02-28T18:47:25.318Z (3 months ago)
• Topics: backup, backup-cli, git, github, github-api, github-backup, github-client
• Language: JavaScript
• Size: 41 KB
• Stars: 8
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
## Github Backup

A tool to backup all of your organisation's github repositories.

[![CircleCI](https://circleci.com/gh/antony/github-backup.svg?style=shield)](https://circleci.com/gh/antony/github-backup) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

![gh-backup](https://user-images.githubusercontent.com/218949/41276919-9dfc3768-6e1d-11e8-9ba0-15f6c9fda601.gif)

### Features

* Private repositories

* Paginates an entire github organisation, not just the first page!

* Parallel clone (10 streams)

* Intuitive CLI to show progress

* Uses github API v3

### Why?

There are a lot of tools out in the wild for the same purpose, but not a single one of them works reliably or paginates a large organisation, so you get the first 50-100 repositories and then you have to edit the code to get more...

### Pre-requisites

You [need a github token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) if you want to backup private repositories. it needs repo permissions.

### Usage

Just install the package locally and run the binary it provides:

```bash

npm i -g @antony/github-backup

github-backup --token  --organisation  --workingDir=./some/path

```

Where:

* `token` is your github token (optional)

* `organisation` is your organisation name

* `workingDir` is where you want the repositories cloned to. If it does not exist it will be created.