Credentials
This CLI is just a wrapper around OpenSubtitles.
That means you have to have your own OpenSubtitles credentials if you want to download subtitles from their services.
To use their API, all you need is:
-
username: you'll have to define one once you've created it; -
password: the same password you define in the account creation you'll be using here (tip: do not reuse passwords); -
apiKey: you'll have to create one once your account is created.
With this information, every time you use the CLI, it'll first do login to get an Access Token so you can find TvShows, series, movies, and also download subtitles.
Check https://opensubtitles.stoplight.io/docs/opensubtitles-api/73acf79accc0a-login
To avoid asking you every single time your credentials, once you log in, your credentials information will be persisted in a JSON file inside your home directory (~/.subtv/db.json).
You can clean your credentials by selecting the option Logout in the main app.
First, access https://opensubtitles.com/.
Then, click on the "register" icon:
A pop-up will appears. Fill in your information and then create on Register.
Check your email for sign-up confirmation.
Once you confirm your account creation, go back to https://opensubtitles.com/ and do login.
Now, you'll need an API key.
On your OpenSubtitle home page, click on your avatar, then API Consumers:
Click on the button New Consumer to create a new apiKey.
Give it any name of your preference (e.g., SubTV Api key), and click on Save:
