https://github.com/rubenarakelyan/backup-github
A simple Ruby script to back up GitHub repositories and gists locally
https://github.com/rubenarakelyan/backup-github
backup github github-api ruby
Last synced: 2 months ago
JSON representation
A simple Ruby script to back up GitHub repositories and gists locally
- Host: GitHub
- URL: https://github.com/rubenarakelyan/backup-github
- Owner: rubenarakelyan
- License: mit
- Created: 2025-02-12T13:06:07.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-12T20:44:16.000Z (4 months ago)
- Last Synced: 2025-03-19T22:08:52.234Z (3 months ago)
- Topics: backup, github, github-api, ruby
- Language: Ruby
- Homepage:
- Size: 6.84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Backup GitHub
A simple Ruby command line script that downloads zip files of all your GitHub repositories and Gists for backup purposes.
## Setup
Ensure you have the correct Ruby version and the `bundler` gem installed. All other gems will be installed automatically the first time you run the script.
## Configuration
Run `ruby backup.rb config --github-access-token GITHUB_ACCESS_TOKEN --backup-directory BACKUP_DIRECTORY`, or copy `config.example.yaml` to `config.yaml` and edit the values.
The script uses a fine-grained personal access token, which you can create at .
Select "all repositories", then give read-only access for "contents" (under repository permissions) and read-write access for "gists" (under "account permissions").
The script does not write anything, but there is no read-only permission level for gists.
The backup directory can be anywhere on your file system that you have write access to, as either an absolute or relative (from the script directory) path.
A `./backups` directory is provided as a default.
## Running backups
There are separate commands for backing up repositories and gists.
### Backing up repositories
Run `ruby backup.rb backup-repos`. By default, this will only get public repositories. Add `--private-repos` to also get private repositories.
For each repository, the script will download a zip file containing the current state of the default branch.
### Backing up gists
Run `ruby backup.rb backup-gists`. This will get all gists (public and secret).
For each gist, the script will download a zip file containing the latest version of all the files in that gist.
## Errors
Most errors are captured and presented with as much information as possible.
If you start seeing `403` errors, it's very likely that you've hit a rate limit. Try again later, and consider increasing the sleep duration between each request.