Astrotitles CLI

Automatically generate subtitles using the Astrotitles command line interface.

View Web App · Report Bug · Request Feature

Getting Started

Astrotitles CLI is a tool that allows you to generate a srt/vtt subtitle file from a audio/video file. Astrotitles has word-level timestamps, allowing you to control how many characters are in each subtitle segment.

Prerequisites

• Python: https://www.python.org/downloads/

Installation

1. Install via pip

   pip install astrotitles

2. Install via pip (github)

   pip install git+https://github.com/Astrotitles/cli.git

(back to top)

Usage

The Astrotitles CLI is self-documented with --help content and examples for every command. You should start exploring the CLI by using the global --help option:

astrotitles --help

usage: astrotitles [-h] [--output OUTPUT] [--output-name OUTPUT_NAME] [--max-chars MAX_CHARS] 
    [--format FORMAT] [--model MODEL] [--verbose VERBOSE] input

Generate a srt/vtt subtitle file from audio/video file

positional arguments:
  input                 Input audio/video file to be transcribed

options:
  -h, --help            show this help message and exit
  --output OUTPUT       Specify output directory for srt/vtt subtitle file
  --output-name OUTPUT_NAME
                        Specify output file name (no extension)
  --max-chars MAX_CHARS
                        Specify the maximum number of characters allowed per subtitle segment
  --format FORMAT       Specify subtitle format (default: .srt)
  --model MODEL         Whisper AI model to use for transcribing
  --verbose VERBOSE     Print out progress of transcription process (default: True)

Thanks for using Astrotitles CLI!

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the AGPL-3.0 License. See LICENSE.txt for more information.

(back to top)

Contact

• Ben Webster
• Project: https://github.com/Astrotitles/cli

(back to top)

Thanks for using Astrotitles! 🔥