]>
Commit | Line | Data |
---|---|---|
726cf1a7 | 1 | # CLI Tube |
726cf1a7 | 2 | |
44978125 JN |
3 | Play videos from YouTube (and maybe other sources in the future) from the |
4 | command line using your preferred desktop media player. | |
5 | ||
a6c167a7 JN |
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) | |
44978125 JN |
10 | |
11 | ## Features | |
12 | ||
13 | - [x] Search for videos using keywords | |
3f6de5cb JN |
14 | - [x] Stream videos |
15 | - [ ] Download videos | |
44978125 | 16 | - [ ] Configuration options |
a000c39c JN |
17 | - [ ] Choice of video players |
18 | - [ ] Show video URLs or not | |
19 | - [ ] Play audio only | |
20 | - [ ] Pagination of search results | |
44978125 | 21 | |
3f6de5cb | 22 | ## Installation |
44978125 | 23 | |
3f6de5cb | 24 | Download the latest build from GitlabCI (amd64 GNU/Linux only). |
44978125 | 25 | |
c4aeb618 JN |
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 | ||
44978125 | 31 | |
3f6de5cb | 32 | For other platforms, create a release artifact using the following command: |
44978125 | 33 | |
3f6de5cb JN |
34 | ```sh |
35 | nim c -d:ssl -d:release clitube.nim | |
44978125 JN |
36 | ``` |
37 | ||
3f6de5cb | 38 | Copy the binary to a directory on your PATH such as `/usr/local/bin` |
44978125 | 39 | |
3f6de5cb | 40 | ## Usage |
44978125 JN |
41 | |
42 | ```sh | |
3f6de5cb | 43 | clitube emacs |
44978125 | 44 | |
c4aeb618 | 45 | # If your search query has multiple words, use quotes |
3f6de5cb | 46 | clitube 'nim lang' |
44978125 | 47 | ``` |
c4aeb618 | 48 | |
3f6de5cb JN |
49 | ## Development |
50 | ||
51 | One-liner for compiling and running | |
c4aeb618 JN |
52 | |
53 | ```sh | |
3f6de5cb | 54 | nim c -d:ssl -r clitube.nim 'nim lang' |
68fd8100 | 55 | ``` |