Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nikolay-borzov/torrent-clean
Deletes files that are not listed in the selected torrent file
https://github.com/nikolay-borzov/torrent-clean
cli nodejs torrent utility
Last synced: 24 days ago
JSON representation
Deletes files that are not listed in the selected torrent file
- Host: GitHub
- URL: https://github.com/nikolay-borzov/torrent-clean
- Owner: nikolay-borzov
- License: mit
- Created: 2019-01-06T17:35:01.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-30T04:48:13.000Z (almost 2 years ago)
- Last Synced: 2025-01-03T04:27:40.099Z (29 days ago)
- Topics: cli, nodejs, torrent, utility
- Language: JavaScript
- Homepage:
- Size: 777 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# torrent-clean
[](./README.md)
[](./README.ru.md)
[![NPM version][npm-image]][npm-url]
![][ci-image]
[![Inline docs][docs-image]][docs-url]
[![Known Vulnerabilities][vulnerabilities-image]][vulnerabilities-url]
[![Maintainability][maintability-image]][maintability-url]
[![Style Guide][style-guide-image]][style-guide-url]
[![Test Coverage][test-coverage-image]][test-coverage-url]
[npm-image]: https://img.shields.io/npm/v/@nikolay-borzov/torrent-clean.svg
[npm-url]: https://npmjs.org/package/@nikolay-borzov/torrent-clean
[ci-image]: https://github.com/nikolay-borzov/torrent-clean/workflows/CI/badge.svg
[docs-image]: https://inch-ci.org/github/nikolay-borzov/torrent-clean.svg?branch=master
[docs-url]: https://inch-ci.org/github/nikolay-borzov/torrent-clean
[vulnerabilities-image]: https://snyk.io/test/github/nikolay-borzov/torrent-clean/badge.svg?targetFile=package.json
[vulnerabilities-url]: https://snyk.io/test/github/nikolay-borzov/torrent-clean?targetFile=package.json
[maintability-image]: https://api.codeclimate.com/v1/badges/093465c943260646aa40/maintainability
[maintability-url]: https://codeclimate.com/github/nikolay-borzov/torrent-clean/maintainability
[style-guide-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg
[style-guide-url]: https://standardjs.com
[test-coverage-image]: https://api.codeclimate.com/v1/badges/093465c943260646aa40/test_coverage
[test-coverage-url]: https://codeclimate.com/github/nikolay-borzov/torrent-clean/test_coverage
CLI utility deletes files not listed in the selected torrent. Useful when torrent is updated and some files have been removed.
## Prerequisites
- Node.js 18 or later
## Install
```
npm i -g @nikolay-borzov/torrent-clean
```
## Usage
```
C:\Downloads\NaturePack\torrent-clean -t C:\torrents\nature-pack.torrent
```
gets files' paths from `nature-pack.torrent` and compares them with files from `C:\Downloads\NaturePack\`. Then files not presented in `nature-pack.torrent` can be deleted.
`torrent-clean` has `tc` alias.
## Arguments
`--torrent` (or `-t`) - Torrent ID (as described in [webtorrent api](https://github.com/webtorrent/webtorrent/blob/master/docs/api.md#clientaddtorrentid-opts-function-ontorrent-torrent-))
- Magnet URI (e.g. `magnet:?xt=urn:btih:d2474e86c95b19b8bcfdb92bc12c9d44667cfa36`)
- Info Hash (e.g. `d2474e86c95b19b8bcfdb92bc12c9d44667cfa36`)
- http/https URL to a torrent file
- Filesystem path to a torrent file
`--dir` (or `-d`) - Path to directory with downloaded files
`--version` - Outputs the app version
## Config files
`torrent-clean` allows specifying some parameters via config file (`.torrent-cleanrc`, `.torrent-cleanrc.json`, `.torrent-cleanrc.yaml`, `.torrent-cleanrc.yml`). There might be many files - `torrent-clean` will collect and merge all files up to root directory. The closer config to the directory is, the higher its priority.
Parameter are:
- `ignore: string[]` - an array of globs ([picomatch](https://github.com/micromatch/picomatch#globbing-features) is used) or filenames that will be excluded from the list of extra files.
- `rememberLastTorrent: boolean` - Enable remembering last specified torrent ID for specified directory to `lastTorrent` config parameter. Only string values are saved. `lastTorrent` is used when `--torrent` argument is not set.
## API
`cleanTorrentDirectory` accepts options object:
```javascript
{
torrentId: '6a9759bffd5c0af65319979fb7832189f4f3c35d',
// Directory to clean
directoryPath: 'C:/Downloads/wallpapers/nature',
// Do not delete files immediately. Instead return `deleteFiles` function
dryRun: true,
// Config with highest priority
customConfig: { ignore: ['**/*\(edited\)*'] },
// Called when config is loaded
onConfigLoaded({ torrent }) { console.log(`Parsed ${torrent}`) }
}
```
```javascript
import { cleanTorrentDirectory } from 'torrent-clean'
const { extraFiles } = await cleanTorrentDirectory({
torrentId: 'C:/torrents/nature wallpapers.torrent',
directoryPath: 'C:/Downloads/wallpapers/nature',
})
console.log('Removed', extraFiles)
```
```javascript
import cleanTorrentDirectory from 'torrent-clean'
const { extraFiles, deleteFiles } = await cleanTorrentDirectory({
torrentId: '6a9759bffd5c0af65319979fb7832189f4f3c35d',
directoryPath: 'C:/Downloads/wallpapers/nature',
dryRun: true,
customConfig: { ignore: ['**/*(edited)*'] },
})
console.log('Removing', extraFiles)
await deleteFiles(extraFiles)
```
## Known issues
- Torrent files with names containing unicode characters (e.g. 𝗚𝗪𝗔 1.txt) cannot be parsed correctly.
- Parsing torrent by hash can sometimes hang. It's better to pass path to torrent file.
### Built with
- [webtorrent](https://github.com/webtorrent/webtorrent)
- [minimist](https://github.com/substack/minimist)
- [cosmiconfig](https://github.com/cosmiconfig/cosmiconfig)
- [enquirer](https://github.com/enquirer/enquirer)
- [readdirp](https://github.com/paulmillr/readdirp)
- [picomatch](https://github.com/micromatch/picomatch)
- [delete-empty](https://github.com/jonschlinkert/delete-empty)
- [chalk](https://github.com/chalk/chalk)