Skip to content

Commit

Permalink
Merge pull request #9 from adrianmg/README
Browse files Browse the repository at this point in the history
Updated README with more information
  • Loading branch information
adrianmg authored Aug 14, 2021
2 parents 65b1dfb + d12dedb commit 4a9ce92
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 19 deletions.
3 changes: 0 additions & 3 deletions .example.env

This file was deleted.

36 changes: 23 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,34 +9,44 @@
<p align="center">
<br>
<img src="./res/preview.gif" alt="Preview of the tool" width="700">
<br><br>
<br>
</p>

Have you ever had too much fun with the GitHub API and ended up creating too many dummy repos? Me too 😅!
## Installation and Usage
To install the latest version of github-pewpew CLI, run this command:
```
npm i -g github-pewpew
```

I made this little CLI tool over the weekend to clean up repositories quickly. I'm planning to add some flags and regexp to delete in bulk in the future. [Let me know](http://twitter.com/adrianmg) if that sounds interesting to you.
To quickly start using it, run the following command:
```
ghpew
```

## Installation and usage

Install it via `npm install github-pewpew` and use it running the command `ghpew` in your terminal.
## Why?
Have you ever had too much fun with the GitHub API and ended up creating too many dummy repos? Me too 😅!

Remember you will need a PAT (Personal Access Token) to authenticate with your GitHub account. You can generate a PAT scoped to 'delete_repo' on https://github.com/settings/tokens.
I made this little CLI tool to clean up repositories quickly. I'm planning to add some flags and regexp to delete in bulk in the future. [Let me know](http://twitter.com/adrianmg) if that sounds interesting to you.

## Roadmap
- Improve auth so you don't need to grab the PAT every time you run the tool
- Advanced flags with: regex, --force
- Add testing
## TODO
- `--force` flag to avoid confirmation
- `--regex` flag to delete repos matching a regex
- `--list` flag to delete repos from a comma-separated list
- Add some testing 😊

## Questions? Ideas? Bugs?

If you run into any issues or you'd like to share your thoughts, feel free to [open an issue](https://github.com/adrianmg/github-pewpew/issues) in this repository or hit me up on [Twitter](https://twitter.com/adrianmg).

## Development

To set up your environment to develop this tool, run `npm install`. You can run the tool by running `node index` in your terminal. Most of the functionality is in the `src/utils.js` file.
To set up your environment to develop this tool, run `npm install`. You can run the tool by running `node index` in your terminal.

The file `src/github.js` contains the logic for the authentication

You can also rename `.example.env ` to `.env` and add your PAT to it to speed up debugging.
and `src/utils.` files.

## License

The tool is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
The tool is available as open-source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "github-pewpew",
"version": "1.1.1",
"version": "1.1.2",
"description": "Pew pew those unnecessary GitHub repos!",
"main": "index.js",
"bin": {
Expand Down

0 comments on commit 4a9ce92

Please sign in to comment.