Add usage section and config reference
This commit is contained in:
16
README.md
16
README.md
@@ -47,6 +47,21 @@ Rename in place (no network lookups):
|
||||
mov-renamarr --input /path/to/in --rename-in-place --no-lookup
|
||||
```
|
||||
|
||||
## Usage :keyboard:
|
||||
```
|
||||
mov-renamarr --input <dir> --output <dir> [flags]
|
||||
```
|
||||
|
||||
Common flags:
|
||||
- `--move` or `--rename-in-place` (default is copy)
|
||||
- `--provider auto|tmdb|omdb|both`
|
||||
- `--no-lookup` (skip external lookups)
|
||||
- `--report [path]` and `--report-format text|json|csv`
|
||||
- `--sidecars` (copy/move subtitle/nfo/etc files)
|
||||
- `--quality-tags resolution,codec,source`
|
||||
- `--min-score 0-100` (match threshold)
|
||||
- `--jobs auto|N` and `--net-jobs auto|N`
|
||||
|
||||
## Configuration :gear:
|
||||
Default config location:
|
||||
`$XDG_CONFIG_HOME/mov-renamarr/config.toml` (fallback `~/.config/mov-renamarr/config.toml`)
|
||||
@@ -68,6 +83,7 @@ Key options (TOML):
|
||||
- `sidecars = false` (copy/move sidecars when true)
|
||||
|
||||
CLI flags override config, and env vars override config as well.
|
||||
Full reference: `docs/CONFIG.md`
|
||||
|
||||
## Providers :globe_with_meridians:
|
||||
- **TMDb**: preferred when available. Supports API key or read-access bearer token.
|
||||
|
||||
Reference in New Issue
Block a user