github-pewpew

    1.2.0 • Public • Published

    🔫 github-pewpew

    Pew pew those unnecessary GitHub repos!
    Clean up your unused repositories within seconds from your CLI.

    npm version


    Preview of the tool

    Installation and Usage

    To install the latest version of github-pewpew CLI, run this command:

    npm i -g github-pewpew
    

    To quickly start using it, run the following command:

    ghpew
    

    Why?

    Have you ever had too much fun with the GitHub API and ended up creating too many dummy repos? Me too 😅!

    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 if that sounds interesting to you.

    Development

    The important parts of the project are the following:

    ├── .github              GitHub Actions workflows and repo settings
    ├── src
    │   ├── config.js        Contains the configuration manager
    │   ├── github.js        Business logic: authentication and API calls
    │   ├── ui.js            CLI interactions
    │   └── utils.js         Lightweight utility functions
    ├── test                 
    │   └── test.js          Test coverage with Mocha
    ├── .prettierrc          Code formatting configuration
    ├── index.js             The main thread of execution
    ├── README.md            you're looking at it
    

    To set up your environment to develop this tool, run:

    • npm install
    • node index

    You can also run node index DEV=true CLIENT_ID=<YOUR_TESTING_CLIENT_ID> if you want to use your own client id for development and testing purposes.

    All the tests are written with mocha and can be run with npm test.

    TODO

    • --force flag to avoid confirmation
    • --regex flag to delete repos matching a regex
    • --list flag to delete repos from a comma-separated list

    Questions? Ideas? Bugs?

    If you run into any issues or you'd like to share your thoughts, feel free to open an issue in this repository or hit me up on Twitter.

    Contributions

    Thanks to @sergiou87, @zschiller, and @mamuso for contributing with their feedback and ideas 🙇‍♂️.

    License

    The tool is available as open-source under the terms of the MIT License.

    Install

    npm i github-pewpew

    DownloadsWeekly Downloads

    3

    Version

    1.2.0

    License

    MIT

    Unpacked Size

    13.6 kB

    Total Files

    7

    Last publish

    Collaborators

    • adrianmg