X-Git-Url: https://njoseph.me/gitweb/nimcoon.git/blobdiff_plain/03a70308b52756e52aeeb883abd012bb06779b33..7d08d1af09a1a9d6ee71c88442580e428f125508:/README.md diff --git a/README.md b/README.md index b851c09..3930178 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # CLI Tube -Play videos from YouTube (and maybe other sources in the future) from the +Play videos from YouTube and PeerTube from the command line using your preferred desktop media player. This application is implemented in [Nim language](https://nim-lang.org) using @@ -12,16 +12,18 @@ only the standard library. - [x] Search for videos using keywords - [x] Stream videos -- [ ] Stream music -- [ ] Download videos +- [x] Stream music +- [ ] Download video +- [ ] Download music - [ ] Configuration options - - [ ] Choice of video players - - [ ] Show video URLs or not - - [ ] Play audio only -- [ ] Pagination of search results +- [ ] Play magnet links ## Installation +CLI Tube depends on the following: +- youtube-dl +- mpv (recommended) or vlc + Download the latest build from GitlabCI (amd64 GNU/Linux only). ```sh @@ -45,8 +47,18 @@ clitube emacs # If your search query has multiple words, use quotes clitube 'nim lang' + +# Advanced: Play audio of the first search result +clitube -m -l "counting stars" ``` +### Commandline arguments + +| **Arguments** | **Explanation** | +|---------------|--------------------------------------------| +| -m, --music | Play Music only, no video | +| -l, --lucky | Try your luck with the first search result | + ## Development One-liner for compiling and running