Github::Backup - Back up your repositories, issues, gists and more
github_backup \ --user stevieb9 \ --token 003e12e0780025889f8da286d89d144323c20c1ff7 --dir /home/steve/github_backup \ --repos \ --issues # You can store the token in an environment variable as opposed to sending # it on the command line export GITHUB_TOKEN=003e12e0780025889f8da286d89d144323c20c1ff7 github_backup -u stevieb9 -d ~/github_backup -r
Back up all of your Github repositories and/or issues to your local machine.
Mandatory: Your Github username.
Mandatory: Your Github API token. If you wish to not include this on the command line, you can put the token into the GITHUB_TOKEN environment variable.
GITHUB_TOKEN
Mandatory: The backup directory where your repositories and/or issues will be stored. The format of the directory structure will be as follows:
backup_dir/ - issues/ - repo1/ - issue_id_x - issue_id_y - repo2/ - issue_id_a - repo1/ - repository data - repo2/ - repository data
The repositories are stored as found on Github. The issues are stored in JSON format.
Optional: Back up all of your repositories found on Github.
Note that either --repos or --issues must be sent in.
--repos
--issues
Optional: Back up all of your issues across all of your Github repositories.
Note that either --issues or --repos must be sent in.
Optional: Send in a proxy in the format https://proxy.example.com:PORT and we'll use this to do our fetching.
https://proxy.example.com:PORT
Display the usage information page.
Instantiates and returns a new Github::Backup object.
Parameters:
Mandatory, String: Your Github username.
Mandatory, String: Your Github API token. Note that if you do not wish to store this in code, you can put it into the GITHUB_TOKEN environment variable, and we'll read it in from there instead.
Mandatory, String: The directory that you wish to store your downloaded Github information to.
Optional, String: Send in a proxy in the format https://proxy.example.com:PORT and we'll use this to do our fetching.
Takes no parameters. Backs up all of your Github repositories, and stores them in the specified backup directory.
Takes no parameters. Backs up all of your Github issues. Stores them per-repo within the /backup_dir/issues directory.
/backup_dir/issues
Steve Bertrand, <steveb at cpan.org>
<steveb at cpan.org>
Copyright 2017,2018 Steve Bertrand.
This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
To install Github::Backup, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Github::Backup
CPAN shell
perl -MCPAN -e shell install Github::Backup
For more information on module installation, please visit the detailed CPAN module installation guide.