Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anhsirk0/file-arranger
Simple & capable Directory arranger/cleaner
https://github.com/anhsirk0/file-arranger
arranger bsd command-line command-line-tool linux perl terminal
Last synced: about 1 month ago
JSON representation
Simple & capable Directory arranger/cleaner
- Host: GitHub
- URL: https://github.com/anhsirk0/file-arranger
- Owner: anhsirk0
- License: gpl-3.0
- Created: 2021-04-19T16:29:32.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-08-20T11:39:11.000Z (over 2 years ago)
- Last Synced: 2024-07-30T19:50:33.174Z (5 months ago)
- Topics: arranger, bsd, command-line, command-line-tool, linux, perl, terminal
- Language: Perl
- Homepage:
- Size: 2.15 MB
- Stars: 59
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
arng
Simple & Capable files arranger (previously arranger)
## About
Arng is a CLI file arng written in Perl
It cleans up your Directory by moving files to their corresponding Directory by their file extension
jpg, png, jpeg, webp -> Images
mp4, mkv, avi, flv -> Videos
and other common filetype extensions
## Features
Arng can
- control maxdepth when arranging
- delete empty Directories
- save logs of what exactly happened
- revert the move using logfile
- move only specific files by provided file extensions & Directory
- arrange more than one Directory
- move unrecognised filetypes to 'Other' Directory
- arrange files by patterns
## Installation
Its just a perl script
download it make it executable and put somewhere in your $PATH
## Via install script
```bash
bash -c "$(curl https://raw.githubusercontent.com/anhsirk0/file-arranger/master/install.sh)"
```
## Manually
with wget
``` bash
wget https://raw.githubusercontent.com/anhsirk0/file-arranger/master/arng.pl -O arng
```
### or
with curl
``` bash
curl https://raw.githubusercontent.com/anhsirk0/file-arranger/master/arng.pl --output arng
```
making it executable
```bash
chmod +x arng
```
copying it to $PATH (~/.local/bin/ , this step is optional)
```bash
cp arng ~/.local/bin/
```
## Usage
```bash
arng [dirs] [options]
```
### dry-run
```bash
$ arng -dry
files2.mp4 -> Videos/files2.mp4
files2.mp3 -> Music/files2.mp3
files1.mp4 -> Videos/files1.mp4
files2.pl -> Other/files2.pl
files1.mp3 -> Music/files1.mp3
files1.pdf -> Documents/files1.pdf
files1.pl -> Other/files1.pl
files2.pdf -> Documents/files2.pdf
0 Files moved
```
### adding verbose
```bash
$ arng -v
files2.mp4 -> Videos/files2.mp4
files2.mp3 -> Music/files2.mp3
files1.mp4 -> Videos/files1.mp4
files2.pl -> Other/files2.pl
files1.mp3 -> Music/files1.mp3
files1.pdf -> Documents/files1.pdf
files1.pl -> Other/files1.pl
files2.pdf -> Documents/files2.pdf
8 Files moved
```
### moving files by extensions to provided dir
```bash
$ arng -ext sh zsh fish -dir shell -v
script.sh -> shell/script.sh
script.zsh -> shell/script.zsh
script.fish -> shell/script.fish
3 Files moved
```
### reversing the move via a logfile
logfiles are stored in `~/.config/arng/logs`
```bash
$ arng -rev "~/.config/arng/logs/logfile1234"
8 files moved
```
### not saving logs and not moving unrecognised filetypes to 'Other'
```bash
$ arng -nl -nu
8 files moved
```
or
```bash
$ arng --no-log --no-unknown
8 files moved
```
### deleting empty directories
```bash
$ arng --delete-empty --no-arrange
2 Directory deleted
0 files moved
```
or
```bash
$ arng -de -na
2 Directory deleted
0 files moved
```
### name/iname
```bash
$ arng -iname "episode*" -dir "Episodes" -v
episode_1.mp4 -> Episodes/episode_1.mp4
EPISODE_3.mp4 -> Episodes/EPISODE_3.mp4
episode_2.mp4 -> Episodes/episode_2.mp4
EPISODE_4.mp4 -> Episodes/EPISODE_4.mp4
4 Files moved
```
### maxdepth
```bash
$ tree
.
└── dir
├── subdir1
│ ├── subdir1_file.mp3
│ ├── subdir1_file.mp4
│ └── subdir1_file.pdf
└── subdir2
├── subdir2_file.mp3
├── subdir2_file.mp4
└── subdir2_file.pdf
3 directories, 6 files
```
```bash
$ arng
0 files moved
```
```bash
$ arng --maxdepth 3 -v
dir/subdir2/subdir2_file.mp4 -> Videos/subdir2_file.mp4
dir/subdir2/subdir2_file.pdf -> Documents/subdir2_file.pdf
dir/subdir2/subdir2_file.mp3 -> Music/subdir2_file.mp3
dir/subdir1/subdir1_file.mp4 -> Videos/subdir1_file.mp4
dir/subdir1/subdir1_file.pdf -> Documents/subdir1_file.pdf
dir/subdir1/subdir1_file.mp3 -> Music/subdir1_file.mp3
6 Files moved
```
## Tweaking arng via config file
you need to create a file ~/.config/arng/arng.conf
you can download the sample config file and move it into the config Directory
```bash
wget https://raw.githubusercontent.com/anhsirk0/file-arranger/master/arng.conf
```
### or
with curl
``` bash
curl https://raw.githubusercontent.com/anhsirk0/file-arranger/master/arng.conf --output arng.conf
```
### move to config dir
```bash
mv arng.conf ~/.config/arng/arng.conf
```
## About config file
- everything should be space separated (don't worry about extra/trailing spaces)
- first word of line would be Directory name rest would be file extensions associated with that Directory