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).
   7
   8 ## Features
   9
  10 - [x] Search for videos using keywords
  11 - [ ] Download or watch videos
  12 - [ ] Configuration options
  13     - [ ] Choice of video players
  14     - [ ] Show video URLs or not
  15     - [ ] Play audio only
  16 - [ ] Pagination of search results
  17
  18 ## Usage
  19
  20 Download the latest build from GitlabCI
  21
  22 ```sh
  23 wget https://gitlab.com/njoseph/cli-tube/-/jobs/artifacts/master/download?job=compile -O artifacts.zip
  24 unzip artifacts.zip
  25 ```
  26
  27 Run the binary
  28
  29 ```sh
  30 ./clitube emacs
  31
  32 ./clitube 'nim lang'
  33 ```
  34
  35 ## Development
  36
  37 ### Compiling and Running
  38
  39 ```sh
  40 nim c -d:ssl -r clitube.nim emacs
  41
  42 # If your search query has multiple words, use quotes
  43 nim c -d:ssl -r clitube.nim 'nim lang'
  44 ```
  45
  46 ### Creating a release artifact
  47
  48 ```sh
  49 nim c -d:ssl -d:release clitube.nim
  50 ```