sub-cli/docs/examples.md

title	description
Command Examples	Practical examples of Sub-CLI commands in action

Command Examples

This page provides practical examples of Sub-CLI commands for common subtitle manipulation tasks.

Format Conversion Examples

Convert between various subtitle formats:

# Convert from SRT to WebVTT
sub-cli convert subtitles.srt subtitles.vtt

# Convert from LRC to SRT
sub-cli convert lyrics.lrc subtitles.srt

# Convert from WebVTT to plain text (stripping timestamps)
sub-cli convert subtitles.vtt plain_text.txt

# Convert from SRT to LRC
sub-cli convert subtitles.srt lyrics.lrc

Synchronization Examples

Synchronize timelines between subtitle files:

# Synchronize an SRT file using another SRT file as reference
sub-cli sync reference.srt target.srt

# Synchronize an LRC file using another LRC file as reference
sub-cli sync reference.lrc target.lrc

Note: Synchronization works between files of the same format. If the number of entries differs between source and target files, Sub-CLI will display a warning and scale the timeline appropriately.

Formatting Examples

Format subtitle files for consistent styling:

# Format an SRT file
sub-cli fmt subtitles.srt

# Format an LRC file
sub-cli fmt lyrics.lrc

# Format a WebVTT file
sub-cli fmt subtitles.vtt

Formatting ensures:

• Sequential entry numbering
• Consistent timestamp formatting
• Proper spacing and line breaks
• Format-specific standard compliance

These examples demonstrate the versatility of Sub-CLI for handling various subtitle manipulation tasks. For detailed information on each command and all available options, see the Command Reference page.