From 05355f54fc32a37ab57fa7605dda94fa4733b528 Mon Sep 17 00:00:00 2001
From: DARKZOUL5 <mihailv@inbox.lv>
Date: Wed, 22 Oct 2025 14:39:50 +0300
Subject: [PATCH] Add CLI flags and env vars docker documentation and clean up
 entrypoint script comments

---
 README.md            | 48 ++++++++++++++++++++++++++++++++++++++++++--
 docker-entrypoint.sh |  8 ++------
 2 files changed, 48 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 9eef05a..7ad4d0b 100644
--- a/README.md
+++ b/README.md
@@ -108,7 +108,30 @@ Edit `yt-playlist-config.json` to specify playlists, paths, and options:
   - Offer to clean up files that are no longer in the playlist
 
 ---
- 
+ ## CLI flags (local / non-container usage)
+
+When running the script locally (for example `python yt-playlist-main.py`), you can pass the following flags:
+
+- `-c, --config <path>` — Path to a configuration file (relative to the repository `config/` directory by default)
+- `-d, --debug` — Show verbose subprocess output (yt-dlp, ffmpeg, aria2c)
+- `-p, --prune` — Enable pruning (deleting files not present in playlists)
+- `-y, --yes, --non-interactive` — Auto-confirm prompts (use with `--prune` in CI)
+
+Examples (local):
+
+```powershell
+# Run with debug output
+python yt-playlist-main.py --debug
+
+# Run non-interactive and prune
+python yt-playlist-main.py --prune --yes
+
+# Use a different config file
+python yt-playlist-main.py --config custom-config.json
+```
+```
+---
+
 ## Docker Usage
 
 You can run YouTube Playlist Downloader using the official Docker image.
@@ -116,7 +139,7 @@ You can run YouTube Playlist Downloader using the official Docker image.
 ### Run the container
 
 ```pwsh
-docker run -v /path/to/downloads:/app/downloads -v /path/to/config:/app/config git.darkzoul.org/dark_zoul/youtube-playlist-downloader:latest
+docker run --rm -v /path/to/downloads:/app/downloads -v /path/to/config:/app/config git.darkzoul.org/dark_zoul/youtube-playlist-downloader:latest
 ```
 
 Replace `/path/to/downloads` and `/path/to/config` with your local directories.
@@ -147,6 +170,27 @@ Run it with:
 docker compose up -d
 ```
 
+## Docker Compose — environment variables
+
+You can pass the same environment variables described below via `docker-compose.yml` using the `environment:` section. Below is a recommended example and a description of each variable.
+
+Environment variables
+- `YTPL_DEBUG` (0/1): When set to `1` shows verbose output from external binaries (yt-dlp, ffmpeg, aria2c). Useful for diagnosing failures.
+- `YTPL_PRUNE` (0/1): When set to `1` enables pruning — files that are not present in any configured playlist will be deleted (requires confirmation unless `YTPL_YES` is set).
+- `YTPL_YES` (0/1): Auto-confirm prompts (use with `YTPL_PRUNE` in automated runs).
+- `YTPL_CONFIG`: Path to a config file inside the container (defaults to `/app/config/yt-playlist-config.json` if present).
+- `YTPL_CONFIG_JSON`: Full JSON payload for the entire config. When provided it overwrites `/app/config/yt-playlist-config.json`.
+- `YTPL_PLAYLISTS_JSON`: JSON array used to populate the `playlists` field in the config.
+- `PLAYLIST_{N}_{FIELD}`: Indexed playlist entries. For each playlist index N use `PLAYLIST_N_URL`, `PLAYLIST_N_DOWNLOAD_MODE`, `PLAYLIST_N_SAVE_PATH`, `PLAYLIST_N_ARCHIVE`, etc.
+- `YTPL_MAX_PARALLEL_DOWNLOADS`: Integer, maximum concurrent downloads.
+- `YTPL_ARIA2C_CONNECTIONS`: Integer, connections per aria2c download.
+- `YTPL_MAX_VIDEO_QUALITY`: String, e.g., `1080p`, `720p`, `best`.
+- `YTPL_DOWNLOAD_MODE`: `audio`, `video`, or `both` — default download mode applied to playlists that don't set it individually.
+
+Tip
+- Mount a config file for complex setups to avoid long environment variables. Example: `- /host/config/yt-playlist-config.json:/app/config/yt-playlist-config.json`.
+
+
 ## Troubleshooting
 
 - **No binaries found:** Ensure paths in `yt-playlist-config.json` are correct and binaries are present.
diff --git a/docker-entrypoint.sh b/docker-entrypoint.sh
index 05bca4a..11c76aa 100644
--- a/docker-entrypoint.sh
+++ b/docker-entrypoint.sh
@@ -28,10 +28,9 @@ fi
 # 1) YTPL_CONFIG_JSON -> full JSON payload for the entire config
 # 2) YTPL_PLAYLISTS_JSON -> JSON array assigned to 'playlists' key in the base config
 # 3) PLAYLIST_{N}_{FIELD} env vars, e.g. PLAYLIST_0_URL, PLAYLIST_0_DOWNLOAD_MODE, etc.
-# Top-level overrides (optional): YTPL_YT_DLP_PATH, YTPL_FFMPEG_PATH, YTPL_ARIA2C_PATH,
-# YTPL_MAX_PARALLEL_DOWNLOADS, YTPL_ARIAC2_CONNECTIONS, YTPL_MAX_VIDEO_QUALITY, YTPL_DOWNLOAD_MODE
+# Top-level overrides (optional): YTPL_MAX_PARALLEL_DOWNLOADS, YTPL_ARIA2C_CONNECTIONS, YTPL_MAX_VIDEO_QUALITY, YTPL_DOWNLOAD_MODE
 
-if [ -n "${YTPL_CONFIG_JSON:-}" ] || [ -n "${YTPL_PLAYLISTS_JSON:-}" ] || env | grep -q '^PLAYLIST_' || [ -n "${YTPL_YT_DLP_PATH:-}" ] || [ -n "${YTPL_FFMPEG_PATH:-}" ] || [ -n "${YTPL_ARIA2C_PATH:-}" ]; then
+if [ -n "${YTPL_CONFIG_JSON:-}" ] || [ -n "${YTPL_PLAYLISTS_JSON:-}" ] || env | grep -q '^PLAYLIST_' ; then
   python - <<'PY'
 import os, json, sys
 from pathlib import Path
@@ -113,9 +112,6 @@ if playlists:
 
 # Top-level overrides
 overrides = {
-  'yt_dlp_path': 'YTPL_YT_DLP_PATH',
-  'ffmpeg_path': 'YTPL_FFMPEG_PATH',
-  'aria2c_path': 'YTPL_ARIA2C_PATH',
   'max_parallel_downloads': 'YTPL_MAX_PARALLEL_DOWNLOADS',
   'aria2c_connections': 'YTPL_ARIA2C_CONNECTIONS',
   'max_video_quality': 'YTPL_MAX_VIDEO_QUALITY',