https://github.com/BrickBot/gh-archive-org

A GitHub CLI extension script to archive all repositories—with their releases—in an organization
https://github.com/BrickBot/gh-archive-org

gh-extension

Last synced: about 1 month ago
JSON representation

A GitHub CLI extension script to archive all repositories—with their releases—in an organization

• Host: GitHub
• URL: https://github.com/BrickBot/gh-archive-org
• Owner: BrickBot
• License: mit
• Created: 2024-02-04T04:29:11.000Z (8 months ago)
• Default Branch: master
• Last Pushed: 2024-06-04T19:44:36.000Z (4 months ago)
• Last Synced: 2024-06-04T21:50:15.762Z (4 months ago)
• Topics: gh-extension
• Language: Shell
• Homepage:
• Size: 20.5 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gh-archive-org

A [GitHub CLI](https://cli.github.com/) extension script to archive all repositories—with their releases—in an organization or under a user, optionally filtering by topic or a [search string](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-for-repositories). If the repository has already been cloned it will attempt to switch to the default branch and pull.

Usage Notes

* This extension can also be executed subsequent times with the same arguments in order to update the archive, including tracking of new branches and pruning of removed ones.

* As this is designed for archiving an org, tracking is against the remote defined for the org.

* While other remotes can be defined manually, this extension is not built to handle any redefining of remotes that might have occurred outside the use of this tool.

This extension script was adapted from Matt Bartel’s [gh-clone-org](https://github.com/matt-bartel/gh-clone-org) by Matthew Sheets.

## Installation

```bash

gh extension install BrickBot/gh-archive-org

```

## Usage

```txt

gh archive-org [-f RELEASE_FILES] [-p PATH] [-r REPO] [-t TOPIC] [-s QUERY] [-y] [-n] [HOST/]ORG

  ORG

    Github organization or user. Required if the GITHUB_ORG environment variable is not set.

  -f, --release_files [all | latest | none]

    Download all releases (default), latest release, or no releases.

  -p, --path PATH

    Archive path, under which org/repo folders will be created. Default: current directory.

  -r, --repo REPO

    Archive only the specified repo(s) within the given org.

    Multiple repos may be specified by separating repo names with spaces

    and then enclosing that entire group in double quotes (e.g. \"repo1 repo2\").

    If this argument is provided, '-t' and '-s' will be ignored.

  -t, --topic TOPIC

    Archive repositories with this topic

  -s --search QUERY

    Archive repositories found by this search string. If this is provided '-t' will be ignored.

    Example: -s \"is:public language:go\"

    See: https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-for-repositories

  -y, --yes

    Archive without prompting for confirmation.

  -n, --dry-run

    Do not actually archive, just show what would be archived

  -h, --help

    Display this message.

```