https://github.com/dawsbot/skrub-cli
Irreversible file deletion on every operating system
https://github.com/dawsbot/skrub-cli
filesystem-utils fs-node rm secure security
Last synced: 12 months ago
JSON representation
Irreversible file deletion on every operating system
- Host: GitHub
- URL: https://github.com/dawsbot/skrub-cli
- Owner: dawsbot
- License: mit
- Created: 2016-05-15T22:36:42.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2020-04-15T13:48:53.000Z (about 6 years ago)
- Last Synced: 2024-05-02T05:38:04.959Z (about 2 years ago)
- Topics: filesystem-utils, fs-node, rm, secure, security
- Language: JavaScript
- Homepage:
- Size: 144 KB
- Stars: 10
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Contributing: .github/contributing.md
- License: license
Awesome Lists containing this project
README
Irreversible file deletion on every operating system
* Will only work securely on file systems that overwrite blocks in place *
Works on OS X, Linux, and Windows
In contrast to `rm`, which [leaves file contents unallocated in memory](http://unix.stackexchange.com/questions/10883/where-do-files-go-when-the-rm-command-is-issued), `skrub` first floods the file with garbage data and then **removes it forever**. Read the [FAQ](https://github.com/dawsonbotsford/skrub#faq) for information on how secure this method is.
Looking for the [npm module instead](https://github.com/dawsonbotsford/skrub)?
## Install
```
npm install --global skrub-cli
```
## Usage
In it's basic form, `skrub` **replaces** `rm`. See how to alias over `rm` [here](#alias)
The API is similar as well:
* `skrub *` == `rm *`
* `skrub *` == `rm -rf *`
* `skrub index.js` == `rm index.js`
```
$ skrub --help
Usage
$ skrub [...]
Options
-d, --dry-run List what would be skrubbed instead of skrubbing
-i, --iterations Write over the file multiple times (defaults to one)
Examples
$ skrub unicorn.png rainbow.png
$ skrub ../* '!../thatSuperImportantThing.txt'
$ skrub ../beCarefulHere --dry-run
$ skrub extraSkrubbed.txt --iterations 36
```
*You can use [glob patterns](https://github.com/sindresorhus/globby#globbing-patterns) and multiple path arguments to compound and negate matches.*
## Alias
If you want to replace `rm` with `skrub`, place this in your `~/.bashrc`, `~/.zshrc`, etc.
```
alias rm=skrub
```
## [FAQ](https://github.com/dawsonbotsford/skrub#faq)
## Related
* [skrub](https://github.com/dawsonbotsford/skrub)
* [kiwf](https://github.com/BrianNewsom/kiwf)
* [del](https://github.com/sindresorhus/del)
* [trash](https://github.com/sindresorhus/trash)
## License
MIT © [Dawson Botsford](http://dawsonbotsford.com)