Updated Readme.md. Included screenshot of drop folder interface
This commit is contained in:
@@ -1,37 +0,0 @@
|
||||
## Required Arguments
|
||||
Table
|
||||
Argument Description
|
||||
-i PATH / --input PATH Input folder path (must contain {anidbN-XXXX} pattern in folder name)
|
||||
|
||||
|
||||
## Optional Arguments
|
||||
Table
|
||||
|
||||
Argument Default Description
|
||||
-r REGEX / --regex REGEX \[SubsPlease\] (.+?) - (\d{2}) \(1080p\) \[\w+\]\.mkv Regex pattern with capture groups for series name and episode number
|
||||
-o NUM / --offset NUM 0 Episode number offset (adds/subtracts from episode numbers found in filenames)
|
||||
-t TITLE / --override-title TITLE (none) Override the series title extracted from regex (optional)
|
||||
-g NUM / --episode-group NUM 2 Which regex capture group contains the episode number (1-indexed)
|
||||
-e / --execute (dry-run) Actually rename files (without this flag, only shows what would be renamed)
|
||||
--history-file PATH regex_history.txt Path to store/load regex pattern history
|
||||
--no-color (colored) Disable colored terminal output
|
||||
-h / --help Show help message and exit
|
||||
|
||||
## Examples
|
||||
### Basic dry-run (safe preview):
|
||||
bash
|
||||
python renamer.py -i "/mnt/media/anime/{anidb4-18874}"
|
||||
### Actually execute the rename:
|
||||
bash
|
||||
python renamer.py -i "/mnt/media/anime/{anidb4-18874}" --execute
|
||||
### Custom regex with offset:
|
||||
bash
|
||||
python renamer.py -i "/path/to/folder" -r "\[Group\] (.+?) - (\d+) \[1080p\].mkv" -o -1 --execute
|
||||
### Override the series title:
|
||||
bash
|
||||
python renamer.py -i "/path/to/folder" -t "My Custom Show Name" --execute
|
||||
### Specify which capture group has the episode number:
|
||||
bash
|
||||
python renamer.py -i "/path/to/folder" -r "(.+?)_EP(\d+)_" -g 2 --execute
|
||||
|
||||
Note: In CLI mode, the script automatically fetches episode titles from AniDB based on the {anidb4-XXXX} pattern in the folder name—you cannot provide custom titles manually (unlike the GUI version).
|
||||
@@ -36,6 +36,7 @@ A Python-based application for managing anime with automated monitoring, notific
|
||||
- [Rule Management Interface](#rule-management-interface)
|
||||
- [Progress Tracking Page](#progress-tracking-page)
|
||||
- [Configuration Settings](#configuration-settings)
|
||||
- [Drop Folder Screen](#drop-folder-screen)
|
||||
- [Development](#development)
|
||||
- [Running Tests](#running-tests)
|
||||
- [Code Style](#code-style)
|
||||
@@ -273,6 +274,8 @@ Once running, access the web dashboard at `http://localhost:5000` (or configured
|
||||
### Configuration Settings
|
||||

|
||||
|
||||
### Drop Folder Screen
|
||||

|
||||
## Development
|
||||
|
||||
### Running Tests
|
||||
|
||||
BIN
Screenshots/Drop Folder Screen.png
Normal file
BIN
Screenshots/Drop Folder Screen.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 96 KiB |
Reference in New Issue
Block a user