An open API service indexing awesome lists of open source software.

https://github.com/wayneashleyberry/gh-arc

✨ A GitHub (gh) CLI extension to find archived dependencies.
https://github.com/wayneashleyberry/gh-arc

cli gh-extension gh-extensions github go modules

Last synced: 5 months ago
JSON representation

✨ A GitHub (gh) CLI extension to find archived dependencies.

Awesome Lists containing this project

README

          

## gh-arc

> ✨ A GitHub (gh) CLI extension to find archived dependencies.

[![Go Reference](https://pkg.go.dev/badge/github.com/wayneashleyberry/gh-arc.svg)](https://pkg.go.dev/github.com/wayneashleyberry/gh-arc)
[![Go Report Card](https://goreportcard.com/badge/github.com/wayneashleyberry/gh-arc)](https://goreportcard.com/report/github.com/wayneashleyberry/gh-arc)
[![lint](https://github.com/wayneashleyberry/gh-arc/actions/workflows/lint.yaml/badge.svg)](https://github.com/wayneashleyberry/gh-arc/actions/workflows/lint.yaml)
[![run](https://github.com/wayneashleyberry/gh-arc/actions/workflows/run.yaml/badge.svg)](https://github.com/wayneashleyberry/gh-arc/actions/workflows/run.yaml)
[![test](https://github.com/wayneashleyberry/gh-arc/actions/workflows/test.yaml/badge.svg)](https://github.com/wayneashleyberry/gh-arc/actions/workflows/test.yaml)
[![release](https://github.com/wayneashleyberry/gh-arc/actions/workflows/release.yaml/badge.svg)](https://github.com/wayneashleyberry/gh-arc/actions/workflows/release.yaml)

### Why?

You have dependencies, and sometimes those dependencies are no longer maintained—their repositories become archived on GitHub. Archived repositories are read-only, will not receive updates, bug fixes, or security patches, and may eventually disappear. Knowing which of your dependencies are archived helps you:

- Identify potential risks in your project due to unmaintained code
- Make informed decisions about replacing or forking dependencies
- Avoid surprises from sudden removals or vulnerabilities

Staying aware of archived dependencies is an important part of keeping your project healthy and secure.

### Installation

Installation is a single command if you already have the [GitHub CLI](https://cli.github.com) installed:

```sh
gh extension install wayneashleyberry/gh-arc
```

The [GitHub CLI](https://cli.github.com) also manages updates:

```sh
gh extension upgrade --all
```

### Usage

#### List Archived Go Modules

```sh
gh arc gomod
```

#### Help

```sh
gh arc help
```

```
NAME:
arc - List archived dependencies

USAGE:
arc [global options] command [command options]

COMMANDS:
gomod List archived go modules
help, h Shows a list of commands or help for one command

GLOBAL OPTIONS:
--debug Print debug logs (default: false)
--help, -h show help
```