Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/statebait/melt

Melt your files and folders on Windows!
https://github.com/statebait/melt

cli npm-package typescript windows

Last synced: 11 days ago
JSON representation

Melt your files and folders on Windows!

Host: GitHub
URL: https://github.com/statebait/melt
Owner: statebait
License: gpl-3.0
Created: 2019-11-17T18:42:42.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2022-12-22T08:28:39.000Z (almost 2 years ago)
Last Synced: 2024-04-24T08:16:32.884Z (7 months ago)
Topics: cli, npm-package, typescript, windows
Language: TypeScript
Size: 405 KB
Stars: 3
Watchers: 3
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# Melt 🔥

[![npm version](https://badge.fury.io/js/%40statebait%2Fmelt.svg)](https://badge.fury.io/js/%40statebait%2Fmelt)
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)

Melt your files and folders on Windows!

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

![melt-demo.gif](https://i.imgur.com/ppsHbjI.gif)

## Getting Started

### Installation

There are currently 2 ways to install `melt`;

1. With npm (you need to have [NodeJS](https://nodejs.org) installed on your machine):

```bash
npm install -g @statebait/melt
```

2. Using the `.exe` and adding it to the path:

- Download the latest release [here.](https://github.com/statebait/melt/releases)

- 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.](https://www.architectryan.com/2018/03/17/add-to-the-path-on-windows-10/))

Congratulations you have `melt` installed on your machine! 🎉

### Usage

For deleting regular files:

```bash
melt
```

For deleting folders (and folders with contents):

```bash
melt -r
```

#### Configure

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

To turn off the warning prompt:

```bash
melt -p off
```

To turn on the warning prompt:

```bash
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