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