[!Note]
v4 is constantly changing so be sure to keep the tool and your plugins up to date. Also, I would advise not using it as a library yet as the API still has many breaking changes.
What is mov-cli? 💫
mov-cli is a command line tool with plugin support that streamlines the process of streaming media from the comfort of your terminal; so you can show off to your friends the superiority of the command line. 💪 The tool is sort of a framework that handles metadata, configuration and scraping of the media to be streamed in your media player of choice.
mov-cli is not a piracy tool; in fact, we encourage the opposite through the existence of our plugins mov-cli-files and mov-cli-jellyplex. 🫵 You obtain the media. You pick the plugins.
Installation 🛠️
[!TIP]
For in-depth installation instructions hit the wiki.
Prerequisites
- A supported platform:
- python (required, with pip)
- lxml (optional, ⚡ faster scraping)
- fzf (optional but highly recommended)
- mpv (recommended & default media player)
To get running these are all the prerequisites you'll need.
With the prerequisites installed, mov-cli can be installed via the pip command on all platforms with Python version 3.8 or above.
pip install mov-cli -U
Check out the wiki on installation for more in-depth guidance on installing mov-cli.
Usage 🖱️
!showcase video
mov-cli comes packaged with a CLI interface via the mov-cli
command you can use in your respective terminal.
[!NOTE]
You may notice mov-cli doesn't ship with any scrapers (or previously known as providers) by default, this is because v4 is plugin-based and scrapers are now part of plugins that must be chosen to be installed.
Find out how to do so at the wiki.
- Install the plugin of your choice. Visit this wiki page on how to do so and the mov-cli-plugin topic for a list of third-party mov-cli plugins.
pip install mov-cli-youtube
This is just an example.
If you are struggling, visit that wiki page.
- Add the plugin to your config.
mov-cli -e
Alternatively, you may also edit by manually opening the config file. See this Wiki page on that.
[mov-cli.plugins]
youtube = "mov-cli-youtube"
Check out the wiki for more in-depth explanation.
- Scrape away!
mov-cli -s youtube blender studio
The command above searches for blender studio
with our youtube plugin, however once again mov-cli is plugin based and there are many of them in the wild. 😉
Star Graph ⭐
Contributing ✨
Pull requests are welcome and appreciated. For major changes, please open an issue first to discuss what you would like to change.
Inspiration 🌟
Inspired by ani-cli, lobster and animdl