Skip to content

Commit ec141b1

Browse files
docs: fix docker compose cli usage
1 parent 9fa59e4 commit ec141b1

9 files changed

Lines changed: 46 additions & 46 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Thanks for your interest in contributing! This guide covers everything you need
3030
docker compose up -d redis web worker
3131

3232
# Run CLI tool
33-
docker compose run --profile cli --rm cli
33+
docker compose run --rm cli
3434

3535
# View logs
3636
docker compose logs -f web worker

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ build:
3030

3131
# Run CLI tool to process all videos
3232
cli:
33-
docker compose run --profile cli --rm cli
33+
docker compose run --rm cli
3434

3535
# Run CLI with batch size limit
3636
cli-batch:
37-
docker compose run --profile cli --rm -e BATCH_SIZE=10 cli
37+
docker compose run --rm -e BATCH_SIZE=10 cli
3838

3939
# ============================================================================
4040
# Web UI Commands

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ docker compose up -d
7676
# Open http://localhost:5000
7777

7878
# OR run CLI directly
79-
docker compose run --profile cli --rm cli
79+
docker compose run --rm cli
8080
```
8181

8282
> **Security Note:** This app exposes media paths and triggers write operations. `DISABLE_AUTH=true` is the default in the example compose — suitable for local access only. For remote/production deployments, set `DISABLE_AUTH=false` and place a reverse proxy with authentication (OAuth2-Proxy, Authelia, Nginx basic auth) in front of the app.
@@ -92,10 +92,10 @@ docker compose up -d
9292
**Process via CLI (headless/batch):**
9393
```bash
9494
# Process entire media library
95-
docker compose run --profile cli --rm cli
95+
docker compose run --rm cli
9696

9797
# Process specific show/season
98-
docker compose run --profile cli --rm -e MEDIA_PATH=/media/tv/ShowName/Season\ 01 cli
98+
docker compose run --rm -e MEDIA_PATH=/media/tv/ShowName/Season\ 01 cli
9999
```
100100

101101
### Run Tests Locally
@@ -267,7 +267,7 @@ After generation, refresh your media library to detect new subtitles.
267267
### Batch Process New TV Season
268268

269269
1. Download new season via Sonarr/Radarr
270-
2. Run: `docker compose run --profile cli --rm -e MEDIA_PATH=/media/tv/ShowName/Season\ 01 cli`
270+
2. Run: `docker compose run --rm -e MEDIA_PATH=/media/tv/ShowName/Season\ 01 cli`
271271
3. Subtitles generated automatically
272272
4. Refresh your media server library to pick up new subtitles
273273

@@ -287,7 +287,7 @@ You can work through it show by show over a few days, or batch everything at onc
287287

288288
1. Create keyterms CSV with character names
289289
2. Create speaker map CSV
290-
3. Run with transcripts enabled: `docker compose run --profile cli --rm -e ENABLE_TRANSCRIPT=1 cli`
290+
3. Run with transcripts enabled: `docker compose run --rm -e ENABLE_TRANSCRIPT=1 cli`
291291
4. Get language-tagged `.srt` subtitles beside the media file plus `.transcript.speakers.txt` output in the sibling `Transcripts/` folder
292292

293293
---

docs/languages.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ Regional variants are trained on local accents, vocabulary, and pronunciation pa
353353

354354
```bash
355355
# CLI Tool
356-
docker compose run --profile cli --rm \
356+
docker compose run --rm \
357357
-e MEDIA_PATH=/media/tv/KoreanDrama \
358358
-e LANGUAGE=ko \
359359
cli
@@ -370,7 +370,7 @@ docker compose run --profile cli --rm \
370370
### Example 2: Regional Variant (British TV)
371371

372372
```bash
373-
docker compose run --profile cli --rm \
373+
docker compose run --rm \
374374
-e MEDIA_PATH=/media/tv/Doctor\ Who \
375375
-e LANGUAGE=en-GB \
376376
cli
@@ -379,7 +379,7 @@ docker compose run --profile cli --rm \
379379
### Example 3: Multilingual Content
380380

381381
```bash
382-
docker compose run --profile cli --rm \
382+
docker compose run --rm \
383383
-e MEDIA_PATH=/media/movies/Multilingual \
384384
-e LANGUAGE=multi \
385385
cli
@@ -390,7 +390,7 @@ docker compose run --profile cli --rm \
390390
### Example 4: Auto-Detection for Unknown Content
391391

392392
```bash
393-
docker compose run --profile cli --rm \
393+
docker compose run --rm \
394394
-e MEDIA_PATH=/media/archive/unknown \
395395
-e DETECT_LANGUAGE=1 \
396396
cli
@@ -402,7 +402,7 @@ Subtitles are written with the detected language tag when possible; otherwise th
402402
### Example 5: Latin American Spanish Content
403403

404404
```bash
405-
docker compose run --profile cli --rm \
405+
docker compose run --rm \
406406
-e MEDIA_PATH=/media/tv/LatAm \
407407
-e LANGUAGE=es-419 \
408408
cli

docs/technical.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -687,47 +687,47 @@ Generate keyterms using AI.
687687

688688
**Process entire library:**
689689
```bash
690-
docker compose run --profile cli --rm cli
690+
docker compose run --rm cli
691691
```
692692

693693
**Process specific directory:**
694694
```bash
695-
docker compose run --profile cli --rm -e MEDIA_PATH=/media/tv/ShowName cli
695+
docker compose run --rm -e MEDIA_PATH=/media/tv/ShowName cli
696696
```
697697

698698
**Process specific season:**
699699
```bash
700-
docker compose run --profile cli --rm -e MEDIA_PATH=/media/tv/ShowName/Season\ 01 cli
700+
docker compose run --rm -e MEDIA_PATH=/media/tv/ShowName/Season\ 01 cli
701701
```
702702

703703
**Process from file list:**
704704
```bash
705-
docker compose run --profile cli --rm -e FILE_LIST_PATH=/config/video-list.txt cli
705+
docker compose run --rm -e FILE_LIST_PATH=/config/video-list.txt cli
706706
```
707707

708708
**Batch processing (limit to 10 files):**
709709
```bash
710-
docker compose run --profile cli --rm -e BATCH_SIZE=10 cli
710+
docker compose run --rm -e BATCH_SIZE=10 cli
711711
```
712712

713713
**Process non-English content:**
714714
```bash
715-
docker compose run --profile cli --rm -e LANGUAGE=es cli
715+
docker compose run --rm -e LANGUAGE=es cli
716716
```
717717

718718
**Generate speaker-labeled transcripts:**
719719
```bash
720-
docker compose run --profile cli --rm -e ENABLE_TRANSCRIPT=1 cli
720+
docker compose run --rm -e ENABLE_TRANSCRIPT=1 cli
721721
```
722722

723723
**Force regenerate SRT files:**
724724
```bash
725-
docker compose run --profile cli --rm -e FORCE_REGENERATE=1 cli
725+
docker compose run --rm -e FORCE_REGENERATE=1 cli
726726
```
727727

728728
**Enable all Nova-3 quality features:**
729729
```bash
730-
docker compose run --profile cli --rm \
730+
docker compose run --rm \
731731
-e NUMERALS=1 \
732732
-e MEASUREMENTS=1 \
733733
-e DETECT_LANGUAGE=1 \
@@ -740,14 +740,14 @@ Process new videos daily:
740740

741741
```bash
742742
# Add to crontab
743-
0 5 * * * cd /path/to/subgeneratorr && docker compose run --profile cli --rm -e BATCH_SIZE=50 cli
743+
0 5 * * * cd /path/to/subgeneratorr && docker compose run --rm -e BATCH_SIZE=50 cli
744744
```
745745

746746
Weekly scan for missing subtitles:
747747

748748
```bash
749749
# Every Sunday at 3 AM
750-
0 3 * * 0 cd /path/to/subgeneratorr && docker compose run --profile cli --rm cli
750+
0 3 * * 0 cd /path/to/subgeneratorr && docker compose run --rm cli
751751
```
752752

753753
---
@@ -1053,7 +1053,7 @@ environment:
10531053
Limit processing to avoid overwhelming your system or API:
10541054
10551055
```bash
1056-
docker compose run --profile cli --rm -e BATCH_SIZE=10 cli
1056+
docker compose run --rm -e BATCH_SIZE=10 cli
10571057
```
10581058

10591059
### Processing Speed

examples/docker-compose.example.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
# 4. docker compose up -d (Web UI at http://localhost:5000)
99
#
1010
# CLI usage:
11-
# docker compose run --profile cli --rm cli
11+
# docker compose run --rm cli
1212

1313
services:
1414
# ==========================================================================
@@ -111,7 +111,7 @@ services:
111111
# ==========================================================================
112112
# CLI Tool - One-shot batch subtitle generation (run manually)
113113
# ==========================================================================
114-
# Usage: docker compose run --profile cli --rm cli
114+
# Usage: docker compose run --rm cli
115115
cli:
116116
build:
117117
context: .

scripts/validate_setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ def main():
209209
print("3. Edit .env: set DEEPGRAM_API_KEY and MEDIA_PATH")
210210
print("4. docker compose build")
211211
print("5. docker compose up -d (Web UI at http://localhost:5000)")
212-
print("6. docker compose run --profile cli --rm cli (CLI tool)")
212+
print("6. docker compose run --rm cli (CLI tool)")
213213
print()
214214
print("Docs: README.md | docs/technical.md | docs/languages.md")
215215
print()
@@ -221,4 +221,4 @@ def main():
221221
return 1
222222

223223
if __name__ == "__main__":
224-
sys.exit(main())
224+
sys.exit(main())

tests/CLI_TEST_PLAN.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ test_data/
4646
**Function:** `extract_audio()`, `transcribe_audio()`, `generate_srt()`
4747
**Command:**
4848
```bash
49-
docker compose run --profile cli --rm \
49+
docker compose run --rm \
5050
-e MEDIA_PATH=/test_data/videos \
5151
-e BATCH_SIZE=1 \
5252
cli
@@ -63,7 +63,7 @@ docker compose run --profile cli --rm \
6363
**Setup:** Place MP3 file in test directory
6464
**Command:**
6565
```bash
66-
docker compose run --profile cli --rm \
66+
docker compose run --rm \
6767
-e MEDIA_PATH=/test_data/audio \
6868
cli
6969
```
@@ -87,7 +87,7 @@ docker compose run --profile cli --rm \
8787
**Function:** `find_videos_without_subtitles()`
8888
**Command:**
8989
```bash
90-
docker compose run --profile cli --rm \
90+
docker compose run --rm \
9191
-e MEDIA_PATH=/test_data/videos \
9292
cli
9393
```
@@ -107,7 +107,7 @@ docker compose run --profile cli --rm \
107107
**Function:** `read_video_list_from_file()`
108108
**Command:**
109109
```bash
110-
docker compose run --profile cli --rm \
110+
docker compose run --rm \
111111
-e FILE_LIST_PATH=/test_data/file_lists/test_list.txt \
112112
cli
113113
```
@@ -126,7 +126,7 @@ docker compose run --profile cli --rm \
126126
**Setup:** Create existing SRT file
127127
**Command:**
128128
```bash
129-
docker compose run --profile cli --rm \
129+
docker compose run --rm \
130130
-e MEDIA_PATH=/test_data/videos \
131131
cli
132132
```
@@ -140,7 +140,7 @@ docker compose run --profile cli --rm \
140140
**Setup:** Existing SRT files present
141141
**Command:**
142142
```bash
143-
docker compose run --profile cli --rm \
143+
docker compose run --rm \
144144
-e MEDIA_PATH=/test_data/videos \
145145
-e FORCE_REGENERATE=1 \
146146
cli
@@ -159,7 +159,7 @@ docker compose run --profile cli --rm \
159159
**Function:** `_generate_transcript()`, `write_transcript()`
160160
**Command:**
161161
```bash
162-
docker compose run --profile cli --rm \
162+
docker compose run --rm \
163163
-e MEDIA_PATH=/test_data/videos \
164164
-e ENABLE_TRANSCRIPT=1 \
165165
cli
@@ -175,7 +175,7 @@ docker compose run --profile cli --rm \
175175
**Setup:** Create speaker map CSV
176176
**Command:**
177177
```bash
178-
docker compose run --profile cli --rm \
178+
docker compose run --rm \
179179
-e MEDIA_PATH=/test_data/videos \
180180
-e ENABLE_TRANSCRIPT=1 \
181181
cli
@@ -201,7 +201,7 @@ docker compose run --profile cli --rm \
201201
**Setup:** Create keyterms CSV file
202202
**Command:**
203203
```bash
204-
docker compose run --profile cli --rm \
204+
docker compose run --rm \
205205
-e MEDIA_PATH=/test_data/videos \
206206
cli
207207
```
@@ -233,7 +233,7 @@ docker compose run --profile cli --rm \
233233
**Function:** Language parameter override
234234
**Command:**
235235
```bash
236-
docker compose run --profile cli --rm \
236+
docker compose run --rm \
237237
-e MEDIA_PATH=/test_data/videos \
238238
-e LANGUAGE=es \
239239
cli
@@ -251,7 +251,7 @@ docker compose run --profile cli --rm \
251251
**Function:** `BATCH_SIZE` parameter
252252
**Command:**
253253
```bash
254-
docker compose run --profile cli --rm \
254+
docker compose run --rm \
255255
-e MEDIA_PATH=/test_data/videos \
256256
-e BATCH_SIZE=2 \
257257
cli
@@ -265,7 +265,7 @@ docker compose run --profile cli --rm \
265265
**Function:** `BATCH_SIZE=0`
266266
**Command:**
267267
```bash
268-
docker compose run --profile cli --rm \
268+
docker compose run --rm \
269269
-e MEDIA_PATH=/test_data/videos \
270270
-e BATCH_SIZE=0 \
271271
cli
@@ -282,7 +282,7 @@ docker compose run --profile cli --rm \
282282
**Setup:** Video with no speech
283283
**Command:**
284284
```bash
285-
docker compose run --profile cli --rm \
285+
docker compose run --rm \
286286
-e MEDIA_PATH=/test_data/videos \
287287
cli
288288
```
@@ -337,7 +337,7 @@ docker compose run --profile cli --rm \
337337
**Function:** `write_raw_json()`, `SAVE_RAW_JSON`
338338
**Command:**
339339
```bash
340-
docker compose run --profile cli --rm \
340+
docker compose run --rm \
341341
-e MEDIA_PATH=/test_data/videos \
342342
-e SAVE_RAW_JSON=1 \
343343
-e ENABLE_TRANSCRIPT=1 \
@@ -418,7 +418,7 @@ docker compose run --profile cli --rm \
418418
**Function:** Complete end-to-end
419419
**Command:**
420420
```bash
421-
docker compose run --profile cli --rm \
421+
docker compose run --rm \
422422
-e MEDIA_PATH=/test_data/videos \
423423
-e BATCH_SIZE=1 \
424424
-e ENABLE_TRANSCRIPT=1 \
@@ -439,7 +439,7 @@ docker compose run --profile cli --rm \
439439
**Setup:** Multiple videos with speaker maps and keyterms
440440
**Command:**
441441
```bash
442-
docker compose run --profile cli --rm \
442+
docker compose run --rm \
443443
-e MEDIA_PATH=/test_data/videos \
444444
-e ENABLE_TRANSCRIPT=1 \
445445
cli

tests/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ TEST: Setup Check
107107
TEST 1.1: Basic Video Transcription
108108
============================================================
109109
110-
[12:35:00] ℹ Running: docker compose run --profile cli --rm -e MEDIA_PATH=/path/test_data/videos -e BATCH_SIZE=1 cli
110+
[12:35:00] ℹ Running: docker compose run --rm -e MEDIA_PATH=/path/test_data/videos -e BATCH_SIZE=1 cli
111111
[12:35:45] ✓ File exists: short_test.eng.srt
112112
[12:35:45] ✓ All patterns found in short_test.eng.srt
113113
[12:35:45] ✓ Processed: 1 files

0 commit comments

Comments
 (0)