README.md

   1 # CLI Tube
   2
   3 Play videos from YouTube and PeerTube from the
   4 command line using your preferred desktop media player.
   5
   6 This application is implemented in [Nim language](https://nim-lang.org) using
   7 only the standard library.
   8
   9 ![clitube screenshot with search term 'baby yoda'](screenshot.png)
  10
  11 ## Features
  12
  13 - [x] Search for videos using keywords
  14 - [x] Stream videos
  15 - [x] Stream music
  16 - [x] Play direct links from YouTube and PeerTube
  17 - [x] Stream video from magnet links
  18 - [ ] Download video
  19 - [ ] Download music
  20 - [ ] Configuration options
  21 - [ ] Play magnet links
  22
  23 ## Installation
  24
  25 CLI Tube depends on the following:
  26 - youtube-dl
  27 - mpv (recommended) or vlc
  28 - peerflix (for magnet links)
  29
  30 Download the latest build from GitlabCI (amd64 GNU/Linux only).
  31
  32 ```sh
  33 wget https://gitlab.com/njoseph/cli-tube/-/jobs/artifacts/master/download?job=compile -O artifacts.zip
  34 unzip artifacts.zip
  35 ```
  36
  37
  38 For other platforms, create a release artifact using the following command:
  39
  40 ```sh
  41 nim c -d:ssl -d:release clitube.nim
  42 ```
  43
  44 Copy the binary to a directory on your PATH such as `/usr/local/bin`
  45
  46 ## Usage
  47
  48 ```sh
  49 clitube emacs
  50
  51 # If your search query has multiple words, use quotes
  52 clitube 'nim lang'
  53
  54 # Advanced: Play audio of the first search result
  55 clitube -m -l "counting stars"
  56 ```
  57
  58 ### Commandline arguments
  59
  60 | **Arguments** | **Explanation**                            |
  61 |---------------|--------------------------------------------|
  62 | -m, --music   | Play Music only, no video                  |
  63 | -l, --lucky   | Try your luck with the first search result |
  64
  65 ## Development
  66
  67 One-liner for compiling and running
  68
  69 ```sh
  70 nim c -d:ssl -r clitube.nim 'nim lang'
  71 ```