Skip to content

barnphp/cnkill

Repository files navigation

   █████████  ██████   █████ █████   ████ █████ █████       █████
  ███░░░░░██  ░██████  ░███  ░███   ███░  ░███  ░███        ░███
 ███     ░░░  ░███░███ ░███  ░███  ███    ░███  ░███        ░███
░███          ░███░░███░███  ░███████     ░███  ░███        ░███
░███          ░███ ░░██████  ░███░░███    ░███  ░███        ░███
░░███     ███ ░███  ░░█████  ░███ ░░███   ░███  ░███      █ ░███      █
 ░░█████████  █████  ░░█████ █████ ░░████ █████ ███████████ ███████████
  ░░░░░░░░░  ░░░░░    ░░░░░ ░░░░░   ░░░░ ░░░░░ ░░░░░░░░░░░ ░░░░░░░░░░░

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

A Blazing Fast, Interactive TUI tool (like npkill) to find and delete vendor/ and node_modules/ directories in your old projects — freeing up disk space fast.

Installation && Update

We provide multiple installation methods to suit your preferences. The recommended way is the standalone executable for Linux and macOS.

  1. Quick install (Linux/macOS, standalone executable):
curl -fsSL https://raw.githubusercontent.com/barnphp/cnkill/master/install.sh | sh
  1. System-wide install (requires sudo):
curl -fsSL https://raw.githubusercontent.com/barnphp/cnkill/master/install.sh | sh -s -- --system
  1. Install via cpx (the npx for PHP):
cpx barnphp/cnkill
  1. Install globally via Composer:
composer global require barnphp/cnkill

You will find it installed in ~/.composer/vendor/bin or ~/.config/composer/vendor/bin. Add it to your PATH or create an alias:

alias cnkill="~/.composer/vendor/bin/cnkill"
# or
alias cnkill="~/.config/composer/vendor/bin/cnkill"

Usage

cnkill [path: defaults to current path] [options]
## Examples

cnkill                          # find vendor/ in current path

cnkill /path/to/projects        # find vendor/ in a specific path

cnkill /path/to/projects --node # find node_modules/ only

cnkill /path/to/projects --all  # find both vendor/ and node_modules/

cnkill /path/to/projects --sort=size  # sort by size

cnkill /path/to/projects --maxdepth=4  # limit search depth

cnkill cache --sort=modified  # sort caches by last modified

Controls

Key Action
/ Navigate the list
/ Page through the list
s Cycle sort mode
Shift + s Toggle sort direction
Space Delete the highlighted directory
q / Ctrl-C Quit

Roadmap

  • Interactive TUI with real-time streaming results
  • Support for vendor/ directories (Composer)
  • Support for node_modules/ directories (npm/yarn)
  • Async size calculation and deletion
  • Add support for Windows
  • Add a build workflow to publish release binaries automatically
  • ... share your ideas in the issues

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please open an issue to report any security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

About

Remove composer vendor and node_modules directories in your projects to save disk space.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Contributors