aboutsummaryrefslogtreecommitdiffstats
path: root/tldw.1
diff options
context:
space:
mode:
authorLouis Burda <dev@sinitax.com>2026-01-24 09:54:23 +0100
committerLouis Burda <dev@sinitax.com>2026-01-24 09:54:23 +0100
commitd94d57191932382291ef9bd1fe76bd9a5bc09d95 (patch)
treedda64c6231a47a6a537c0211ba1c850c5b271411 /tldw.1
parent381c4b264d86bbdd2919eda27cae1ee133eebdaa (diff)
downloadtldw-master.tar.gz
tldw-master.zip
Rewrite for direct use with different LLM providersHEADmaster
Diffstat (limited to 'tldw.1')
-rw-r--r--tldw.181
1 files changed, 81 insertions, 0 deletions
diff --git a/tldw.1 b/tldw.1
new file mode 100644
index 0000000..8b9c2a2
--- /dev/null
+++ b/tldw.1
@@ -0,0 +1,81 @@
+.TH TLDW 1 "January 2025" "tldw 0.1.0" "User Commands"
+.SH NAME
+tldw \- summarize YouTube videos using Claude
+.SH SYNOPSIS
+.B tldw
+.RB [ \-l
+.IR language ]
+.RB [ \-r ]
+.RB [ \-m
+.IR model ]
+.RB [ \-s
+.IR prompt ]
+.I url
+.SH DESCRIPTION
+.B tldw
+(Too Long; Didn't Watch) fetches the transcript of a YouTube video and
+generates a summary using Claude AI.
+.SH OPTIONS
+.TP
+.BI \-l " language" ", \-\-language " language
+Language code for captions (e.g., en, es, fr, de).
+Default is
+.BR en .
+.TP
+.BR \-r ", " \-\-raw
+Output the raw transcript text without summarizing.
+.TP
+.BI \-m " model" ", \-\-model " model
+Model to use in provider/model format (e.g., openai/gpt-4o, anthropic/claude-sonnet-4-20250514).
+Default is
+.BR claude/sonnet .
+.TP
+.BI \-s " prompt" ", \-\-system-prompt " prompt
+Custom prompt for the LLM. The transcript will be appended after this prompt.
+Default is "Summarize the following video transcript:".
+.TP
+.I url
+YouTube video URL in the format https://www.youtube.com/watch?v=VIDEO_ID
+.SH EXAMPLES
+Summarize a video using English captions:
+.PP
+.RS
+.nf
+tldw "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
+.fi
+.RE
+.PP
+Summarize using Spanish captions:
+.PP
+.RS
+.nf
+tldw -l es "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
+.fi
+.RE
+.PP
+Output raw transcript without summarizing:
+.PP
+.RS
+.nf
+tldw -r "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
+.fi
+.RE
+.PP
+Use OpenAI for summarization:
+.PP
+.RS
+.nf
+tldw -m openai/gpt-4o "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
+.fi
+.RE
+.SH ENVIRONMENT
+.TP
+.B ANTHROPIC_API_KEY
+API key for the Anthropic provider.
+.TP
+.B OPENAI_API_KEY
+API key for the OpenAI provider.
+.SH SEE ALSO
+.BR yt-transcript (1)
+.SH AUTHORS
+Louis Burda