Skip to content

Latest commit

 

History

History
103 lines (70 loc) · 2.23 KB

README.md

File metadata and controls

103 lines (70 loc) · 2.23 KB

A gh-extension to manage privacy on github

Warning

Turning a starred repository into a private repository will lose all the stars
Current forks will remain public and will be detached from the repository.

Important

if it has >= 1 stars, ghpm does not turn a starred repository into a private repository.
It does not turn your README repository (username/username) private because it's a special repository meant for public display

Note

I am not sponsored by github, nor affiliated, but you can change that by pinging them on social media. And ask for this functionality to be integrated directly into the gh CLI

Requirements

Installation

supported operating systems

  • linux-amd64
  • linux-arm64
  • darwin-arm64
  • darwin-amd64

not supported operating systems

  • freebsd-amd64
  • freebsd-arm64
  • linux-386
  • windows-386.exe
  • windows-amd64.exe
  • windows-arm64.exe
gh extension install Neal-C/gh-ghpm-rs

List your extensions

gh extension list

Upgrade

gh extension upgrade ghpm-rs

Uninstall

gh extension remove ghpm-rs

Usage

# prints help message
gh ghpm-rs --help
# turns all your repositories private (except starred repos)
gh ghpm-rs thanos_snap

Only turn 1 repository private

The github cli already supports turning 1 repository private: https://cli.github.com/manual/gh_repo_edit

gh repo edit myusername/myrepository --visibility private

Roadmap

  • switch every repositories to private (excluding repos with >= 1 stars)
  • Lobby github to provide a batch request endpoint, so that it's only 1 HTTPS request and not O(n) HTTPS requests
  • Lobby github to add this functionality to the gh CLI

Contributing

I am open to random pull requests that do at least 1 of the following :

  • cross items off the roadmap
  • fix typos
  • add tooling
  • add tests
  • add/improve documentation
  • improve CI/CD

How to permanently delete or hide data from a repository ?

Only sure way is to contact github support : https://support.github.com/

When in doubt, revoke and rotate your keys. Or better yet, automate it.

Made with 💞 love 💞 for developers by a developer ❤️