SubtitlesX
CLI to download subtitles for movies and series.
Installation
Module available through the
npm registry. It can be installed using the
npm
or
yarn
command line tools.
# NPM npm install subtitlesx --save# Or Using Yarn yarn add subtitlesx
Documentation
CLI
Run subtitlesx --help
API
getSubtitles(dir, name, langId, userAgent)
e.g getSubtitles('/root/movies/', 'Interstellar.mp4', 'en', 'TemporaryUserAgent')
Tests
To run the test suite, first install the dependencies, then run test
:
# NPM npm test# Or Using Yarn yarn test
Dependencies
- caporal: A full-featured framework for building command line applications (cli) with node.js
- opensubtitles-api: opensubtitles.org api wrapper
- request: Simplified HTTP request client.
- request-promise-native: The simplified HTTP request client 'request' with Promise support. Powered by native ES6 promises.
- zlib: Simple, synchronous deflate/inflate for buffers
- snyk: snyk library and cli utility
Contributors
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue. List of all contributors.