{"id":13479060,"url":"https://github.com/benbalter/github_records_archiver","last_synced_at":"2025-03-27T08:31:19.916Z","repository":{"id":52608569,"uuid":"49294727","full_name":"benbalter/github_records_archiver","owner":"benbalter","description":"Backs up a GitHub organization's repositories and all their associated information for archival purposes.","archived":true,"fork":false,"pushed_at":"2021-04-23T15:28:13.000Z","size":123,"stargazers_count":108,"open_issues_count":2,"forks_count":22,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-19T21:50:29.034Z","etag":null,"topics":["backup","data-liberation","data-migration","data-portability","export","github"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/benbalter.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":".github/funding.yml","license":"LICENSE.md","code_of_conduct":"docs/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"docs/SECURITY.md","support":null},"funding":{"patreon":"benbalter"}},"created_at":"2016-01-08T20:31:55.000Z","updated_at":"2024-04-11T03:47:26.000Z","dependencies_parsed_at":"2022-09-24T20:13:08.081Z","dependency_job_id":null,"html_url":"https://github.com/benbalter/github_records_archiver","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benbalter%2Fgithub_records_archiver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benbalter%2Fgithub_records_archiver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benbalter%2Fgithub_records_archiver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benbalter%2Fgithub_records_archiver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/benbalter","download_url":"https://codeload.github.com/benbalter/github_records_archiver/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245809891,"owners_count":20676075,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backup","data-liberation","data-migration","data-portability","export","github"],"created_at":"2024-07-31T16:02:08.542Z","updated_at":"2025-03-27T08:31:19.074Z","avatar_url":"https://github.com/benbalter.png","language":"Ruby","readme":"**This project is no longer maintained. If you are interested in archiving your user or organization data, please use the purpose-built [migration API](https://developer.github.com/changes/2018-05-24-user-migration-api/) instead.**\n\n---\n\n# GitHub Records Archiver\n\n[![Build Status](https://travis-ci.org/benbalter/github_records_archiver.svg?branch=master)](https://travis-ci.org/benbalter/github_records_archiver) [![Gem Version](https://badge.fury.io/rb/github_records_archiver.svg)](http://badge.fury.io/rb/github_records_archiver) [![Coverage Status](https://coveralls.io/repos/github/benbalter/github_records_archiver/badge.svg)](https://coveralls.io/github/benbalter/github_records_archiver) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)\n\nBacks up a GitHub organization's repositories and all their associated information for archival purposes.\n\n## What it archives\n\n* Git data (change history, tags, branches, etc.)\n* Wikis (including change history)\n* Issues and pull request (including comments, current state, etc.)\n* Teams (including members and repository permissions)\n\n## Requirements\n\n1. Ruby\n2. A GitHub [personal access token](https://github.com/settings/tokens/new) with `repo` scope.\n\n## Setup\n\nIf you have Ruby installed, simply run:\n\n```shell\ngem install github_records_archiver\n```\n\n## Basic usage\n\n```shell\n$ github-records-archiver archive ORGANIZATION --token PERSONAL_ACCESS_TOKEN`\n```\nAlternatively, you could pass the personal access token as the `GITHUB_TOKEN` environmental variable:\n\n```shell\n$ GITHUB_TOKEN=1234 github-records-archiver archive ORGANIZATION`\n```\n\n## Output\n\nThe script will create an `archive` directory, with one folder for each organization.\n\nWithin each organization folder, there will be one folder per repository.\n\nWithin each repository folder will be the repository content as a git repository.\n\nIf the repository has a Wiki, the wiki will be cloned as a `wiki` subfolder, as a Git repository.\n\nIf the repository has issues or pull requests, it will create an `issues` sub-folder with each issue and its associated comments stored as both markdown (human readable) and JSON (machine readable).\n\nExample output:\n\n```\n├─ archive\n├─── organization\n├──── repository\n├────── README.md\n├────── LICENSE.txt\n├──── wiki\n├────── wiki-page.md\n├──── issues\n├────── 1.md\n├────── 1.json\n├─── another organization\n├──── another-repository\n├────── README.md\n├────── LICENSE.txt\n├──── wiki\n├────── wiki-page.md\n├──── issues\n├────── 1.md\n├────── 1.json\n```\n\n## Advanced usage\n\nYou may set the following flags:\n\n* `--dest-dir` - the destination archive directory, defaults to `./archive`\n* `--verbose` - verbose output while archiving\n\nAdditionally, the following commands are also available:\n\n* `delete [ORGANIZATION]` - delete the entire archive directory or an organization's archive\n* `help` - display help information\n* `version` - display the GitHub Record Archiver version\n","funding_links":["https://patreon.com/benbalter"],"categories":["Ruby"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenbalter%2Fgithub_records_archiver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbenbalter%2Fgithub_records_archiver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenbalter%2Fgithub_records_archiver/lists"}