https://github.com/abdelhamiderrahmouni/vendorkill

Simple command to delete composer vendor folders in your Linux system and free up your storage.
https://github.com/abdelhamiderrahmouni/vendorkill

composer npkill php storage vendor

Last synced: 5 days ago
JSON representation

Simple command to delete composer vendor folders in your Linux system and free up your storage.

• Host: GitHub
• URL: https://github.com/abdelhamiderrahmouni/vendorkill
• Owner: abdelhamiderrahmouni
• License: mit
• Created: 2024-02-20T17:34:39.000Z (11 months ago)
• Default Branch: master
• Last Pushed: 2024-02-21T15:10:12.000Z (11 months ago)
• Last Synced: 2024-11-24T17:05:02.963Z (about 1 month ago)
• Topics: composer, npkill, php, storage, vendor
• Language: PHP
• Homepage:
• Size: 26.7 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Vendor Kill

[![Latest Version on Packagist](https://img.shields.io/packagist/v/abdelhamiderrahmouni/vendorkill.svg?style=flat-square)](https://packagist.org/packages/abdelhamiderrahmouni/vendorkill)

[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/abdelhamiderrahmouni/vendorkill/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/abdelhamiderrahmouni/vendorkill/actions?query=workflow%3Arun-tests+branch%3Amain)

[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/abdelhamiderrahmouni/vendorkill/pint.yml?branch=master&label=code%20style&style=flat-square)](https://github.com/abdelhamiderrahmouni/vendorkill/actions?query=workflow%3A"pint"+branch%3Amaster)

[![Total Downloads](https://img.shields.io/packagist/dt/abdelhamiderrahmouni/vendorkill.svg?style=flat-square)](https://packagist.org/packages/abdelhamiderrahmouni/vendorkill)

a composer package to install globally and remove composer vendor folders in you old project to save storage.

## Installation && Update

You can install the package globally via composer (and update it) by running the following command:

```bash

composer global require abdelhamiderrahmouni/vendorkill

```

you will find it installed in `~/.composer/vendor/bin` or `~/.config/composer/vendor/bin` directory.

add it to your path to use it globally or create an alias like the following:

```bash

alias vendorkill="~/.composer/vendor/bin/vendorkill"

# or

alias vendorkill="~/.config/composer/vendor/bin/vendorkill"

```

## Usage

```bash

vendorkill [path: defaults to current path] [options: --maxdepth=2 --full]

```

```bash

## Examples

vendorkill # remove vendor folders in current path

vendorkill /path/to/project # remove vendor folders in /path/to/project

vendorkill /path/to/project --maxdepth=4 # remove vendor folders in /path/to/project with maxdepth=4

vendorkill /path/to/project --full # remove vendor folders in /path/to/project and all subdirectories

```

## Roadmap

- [x] create the command

- [ ] add support for windows

- [ ] add a build workflow to build the phar file automatically

- ... share your ideas in the [issues](https://github.com/abdelhamiderrahmouni/vendorkill/issues)

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](/.github/CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please open an [issue](https://github.com/abdelhamiderrahmouni/vendorkill/issues) to report any security vulnerabilities.

## Credits

- [Abdelhamid Errahmouni](https://github.com/abdelhamiderrahmouni)

- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.