README.md

   1 # CLI Tube
   2
   3 Play videos from YouTube (and maybe other sources in the future) 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 - [ ] Download videos
  16 - [ ] Configuration options
  17     - [ ] Choice of video players
  18     - [ ] Show video URLs or not
  19     - [ ] Play audio only
  20 - [ ] Pagination of search results
  21
  22 ## Installation
  23
  24 Download the latest build from GitlabCI (amd64 GNU/Linux only).
  25
  26 ```sh
  27 wget https://gitlab.com/njoseph/cli-tube/-/jobs/artifacts/master/download?job=compile -O artifacts.zip
  28 unzip artifacts.zip
  29 ```
  30
  31
  32 For other platforms, create a release artifact using the following command:
  33
  34 ```sh
  35 nim c -d:ssl -d:release clitube.nim
  36 ```
  37
  38 Copy the binary to a directory on your PATH such as `/usr/local/bin`
  39
  40 ## Usage
  41
  42 ```sh
  43 clitube emacs
  44
  45 # If your search query has multiple words, use quotes
  46 clitube 'nim lang'
  47 ```
  48
  49 ## Development
  50
  51 One-liner for compiling and running
  52
  53 ```sh
  54 nim c -d:ssl -r clitube.nim 'nim lang'
  55 ```