sub-cli/docs/getting-started.md

title	description
Getting Started	Introduction to the Sub-CLI tool and its capabilities

Getting Started with Sub-CLI

::: info Current Status

We've in the process of building basic features of Sub-CLI. Behavior may be unstable.

:::

Sub-CLI is a command-line tool designed for subtitle manipulation and generation. Whether you need to convert subtitle formats, synchronize timelines, format subtitle files, Sub-CLI provides a robust set of features for all your subtitle needs.

What Can Sub-CLI Do?

• Convert between various subtitle formats (SRT, VTT, LRC, ASS, TXT)
• Synchronize timelines between subtitle files
• Format subtitle files to ensure consistent styling

Key Features

• Format Flexibility: Support for multiple subtitle formats including SRT, VTT, LRC, ASS, and plain text
• Timeline Synchronization: Easily align subtitles with audio/video content
• Format-Specific Feature Preservation: Maintains format-specific features during conversion
• Clean Command Interface: Simple, intuitive commands for efficient workflow

Quick Navigation

Ready to dive in? Here's where to go next:

• Installation Guide - Download and set up Sub-CLI on your system
• Command Examples - See practical examples of Sub-CLI in action
• Command Reference - Detailed documentation for all available commands
• Provide Feedback - Help us improve Sub-CLI by sharing your experience

Basic Usage

Once installed, you can start using Sub-CLI with simple commands like:

# Convert a subtitle from one format to another
sub-cli convert input.srt output.vtt

# Synchronize timelines between two subtitle files
sub-cli sync source.srt target.srt

# Format a subtitle file
sub-cli fmt subtitle.srt

# Convert to ASS format
sub-cli convert input.srt output.ass

Check out the Command Examples page for more detailed usage scenarios.