public class GitHubBackup
extends Object

Backs up GitHub information to a branch in a local git repository. This is an easy way to back up information about a repository without touching a main branch of the repository. For example - GitHub issues, comments, pull requests, etc... all live exclusively on the GitHub cloud. Using this tool allows you to preserve that information locally, and view a history of what has changed in your repository.

NB: authentication via specifying a id and pass parameter is highly recommended. Unauthenticated API access is rate limited to 60 per hour, while authenticated is rate limited to 5,000.

If the API access limit is reached at any point, the backup process will stop. A resume file will be written which will be automatically consumed during subsequent runs to begin backing up at the GitHub API limits typically refresh every hour. Note that the backup execution is linear to allow this resume functionality, so on a resumed execution, modifications to previously backed up entities will NOT be detected.

To start a new backup from scratch, run with the "-c" flag.