CDN
deae4a6272
All checks were successful
Build and Release / Build (darwin-arm64) (push) Successful in 19s
Build and Release / Build (darwin-amd64) (push) Successful in 20s
Build and Release / Build (linux-arm64) (push) Successful in 17s
Build and Release / Build (linux-amd64) (push) Successful in 20s
Build and Release / Build (windows-arm64) (push) Successful in 16s
Build and Release / Build (windows-amd64) (push) Successful in 19s
Build and Release / Create Release (push) Has been skipped
Deploy docs / deploy (push) Successful in 45s
47 lines
1.7 KiB
Markdown
47 lines
1.7 KiB
Markdown
---
|
|
title: Getting Started
|
|
description: Introduction to the Sub-CLI tool and its capabilities
|
|
---
|
|
|
|
# Getting Started with Sub-CLI
|
|
|
|
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, 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, 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](/installation) - Download and set up Sub-CLI on your system
|
|
- [Command Examples](/examples) - See practical examples of Sub-CLI in action
|
|
- [Command Reference](/commands) - Detailed documentation for all available commands
|
|
- [Provide Feedback](/feedback) - Help us improve Sub-CLI by sharing your experience
|
|
|
|
## Basic Usage
|
|
|
|
Once installed, you can start using Sub-CLI with simple commands like:
|
|
|
|
```bash
|
|
# 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
|
|
```
|
|
|
|
Check out the [Command Examples](/examples) page for more detailed usage scenarios.
|