Skip to content

statebait/melt

Repository files navigation

Melt 🔥

npm version Conventional Commits

Melt your files and folders on Windows!

A configurable utility tool which provides rm like functionality for Windows machines.

melt-demo.gif

Getting Started

Installation

There are currently 2 ways to install melt;

  1. With npm (you need to have NodeJS installed on your machine):
npm install -g @statebait/melt
  1. Using the .exe and adding it to the path:

    • Download the latest release here.

    • Extract the downloaded zip file into a folder.

    • Add the path to bin folder in your environment variables appropriately (see how to do this here.)

Congratulations you have melt installed on your machine! 🎉

Usage

For deleting regular files:

melt <file_name>

For deleting folders (and folders with contents):

melt <folder_name> -r

Configure

You can configure melt to disable/enable the warning prompt while using the recursive option.

To turn off the warning prompt:

melt -p off

To turn on the warning prompt:

melt -p on

All flags

  • Display the current version of melt: -v or --version

  • Display help: -h or --help

  • Configure warning prompt: -p or --prompt

  • Recursive delete (for folders): -r or --recursive

License

This project is licensed under the GPL-3.0 License - Copyright (c) 2020 Mohamed Shadab