https://github.com/octoherd/script-delete-repository

An Octoherd script to delete repositories
https://github.com/octoherd/script-delete-repository

octoherd-script

Last synced: 3 months ago
JSON representation

An Octoherd script to delete repositories

• Host: GitHub
• URL: https://github.com/octoherd/script-delete-repository
• Owner: octoherd
• License: isc
• Created: 2021-04-19T17:42:28.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-30T09:04:48.000Z (4 months ago)
• Last Synced: 2024-07-30T12:16:01.029Z (4 months ago)
• Topics: octoherd-script
• Language: JavaScript
• Size: 90.8 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-octoherd-scripts - Delete repository - Delete repositories. (Scripts)

README

        
# script-delete-repository

> An Octoherd script to delete repositories

[![@latest](https://img.shields.io/npm/v/@octoherd/script-delete-repository.svg)](https://www.npmjs.com/package/@octoherd/script-delete-repository)

[![Build Status](https://github.com/octoherd/script-delete-repository/workflows/Test/badge.svg)](https://github.com/octoherd/script-delete-repository/actions?query=workflow%3ATest+branch%3Amain)

## Usage

Minimal usage (You have to set a token because the built-in OAuth flow creates a token with the `repo` scope, but this script requires the `delete_repo` scope. You can create such a token at https://github.com/settings/tokens/new?scopes=delete_repo)

```js

npx @octoherd/script-delete-repository \

  -T ghp_0123456789abcdefghjklmnopqrstuvwxyzA \

```

Pass all options as CLI flags to avoid user prompts

```js

npx @octoherd/script-delete-repository \

  -T ghp_0123456789abcdefghjklmnopqrstuvwxyzA \

  -R "octoherd/*"

```

## Options

| option                   | type             | description                                                                                                                                                                                                                                 |

| ------------------------ | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

| `--octoherd-token`, `-T` | string           | A personal access token ([create](https://github.com/settings/tokens/new?scopes=repo)). Script will create one if option is not set                                                                                                         |

| `--octoherd-repos`, `-R` | array of strings | One or multiple space-separated repositories in the form of `repo-owner/repo-name`. `repo-owner/*` will find all repositories for one owner. `*` will find all repositories the user has access to. Will prompt for repositories if not set |

| `--octoherd-bypass-confirms` | boolean | Bypass prompts to confirm mutating requests |

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md)

## About Octoherd

[@octoherd](https://github.com/octoherd/) is project to help you keep your GitHub repositories in line.

## License

[ISC](LICENSE.md)