substract-cli

substract-cli

substract-cli is a command-line interface built to interact with the substract library, which enables efficient extraction of hard-coded subtitles from video files. This CLI leverages the substract library's powerful OCR-based subtitle extraction features, making it straightforward to integrate with video processing workflows directly from the command line.

Table of Contents

• Features

• Installation

• Usage

• Commands

• Options

• Requirements

• License

Features

• Subtitle Extraction: Retrieves embedded subtitles from video files using OCR technology.
• User-Friendly CLI: Simplified commands to streamline the subtitle extraction process.
• Configurable Options: Control extraction parameters such as frame frequency, duplicate text filtering, and OCR paths directly through CLI options.
• Enhanced Logging: Real-time feedback on extraction progress, including OCR and frame processing.
• Popular Platforms: Supports Facebook, X (formerly Twitter), YouTube links.

Installation

To install the Substract CLI, ensure you have Node.js version 20.0.0 or later.

npm install -g substract-cli

Or

npx substract-cli

Or

bunx substract-cli

Usage

To use the CLI, run the following command with the required arguments:

substract-cli [options]

Example:

substract-cli path/to/video.mp4 --output path/to/output.json --frequency 5

# outputs 123456.txt
substract-cli "https://www.facebook.com/watch/?v=123456"

# outputs TKdI.txt
substract-cli "https://www.youtube.com/watch?v=TKdI"

substract-cli "https://x.com/user/status/13245"

Options

Option	Type	Description
--apple-binary-path	string	The path to the OCR engine compiled for the Apple environment. If this is set at least once, the cli will reuse this value next time even if it is not provided. You can get a copy from here.
--concurrency	number	The number of threads to use to process the OCR.
--frequency	number	The frequency in seconds after which to extract a frame for subtitles.
--bottom	number	The percent of pixels from the bottom (ie: 20 for 20%) of the video to crop to extract the subtitles.
--top	number	The percent of pixels from the top (ie: 20 for 20%) of the video to crop to extract the subtitles.
--left	number	The percent of pixels from the left (ie: 20 for 20%) of the video to crop to extract the subtitles.
--right	number	The percent of pixels from the right (ie: 20 for 20%) of the video to crop to extract the subtitles.
--output-file	number	The output file to write the extracted subtitles to. This can have a .json or .txt extension. If this is omitted, the output file will be a .txt file in the same directory as the input.

Requirements

• Node.js v20.0.0+

License

Licensed under the MIT License.