github-backup(1)

📦 version 1.20200721, in ubuntu jammy

💖 github-backup — the manual, but make it make sense 💖

okay so bestie, welcome to github-backup(1) from the General Commands Manual section of your friendly neighbourhood man pages. she's a little shell script with big main character energy and she is literally about to save ur whole GitHub life. 🫶

✨ NAME ✨

github-backup — backs up data from GitHub. that's it. that's the whole vibe. 💅

🌸 SYNOPSIS 🌸

github-backup [username|organization ...] [options]

look at her. so simple. so iconic. 👑

🦋 DESCRIPTION 🦋

so github-backup is a simple tool u run inside a git repository that u already cloned from GitHub. and when i say it backs stuff up, i mean it backs up everything GitHub publishes about that repository, including:

  • other branches
  • tags
  • forks
  • issues
  • comments
  • wikis
  • milestones
  • pull requests
  • watchers

like. all of it. she's thorough. she's giving archivist. she's giving "ur fave repo but in a bunker". 🔥

alternately?? if u pass her the username of a GitHub user, she will check out, and back up, all that user's repositories, plus all the repositories that user is watching. no cap. (this also works if u pass the name of an organization on GitHub, so orgs get the same treatment 💖)

by default she runs without logging in to GitHub. if u want to log in, set GITHUB_OAUTH_TOKEN to an oath or personal access token.

⚠️ okay important bestie, read this twice: logging in only works around API rate limiting. it does not allow private repositories to be downloaded. that's the whole deal. don't @ me. 😭

🎀 OPTIONS 🎀

  • --exclude=username/repository — when ur backing up a user or an organization, this lets u skip a particular repository belonging to that user or organization. u can specify this option any number of times to exclude more than one repository. stack em up babes. 🍓
  • --no-forks — avoid backing up a repository's forks. that's it, she said no forks, periodt. 🙈

💜 AUTHOR 💜

Joey Hess <id@joeyh.name> — the legend herself. respect the icon. 👑

<div style="text-align:center">🌸 🦋 🎀 🫶 💅 🔥 👑 🌈 ⭐ 💖</div>

and that's the whole page bestie!! this lil masterpiece comes to u from the Commands manual, filed under github-backup(1). go back up ur repos, hydrate, and remember: logging in only fixes rate limiting, never private repos. slay. 💖✨🫶

📦 where this page comes from