]>
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 | |
14 | - [ ] Download or watch videos | |
15 | - [ ] Configuration options | |
a000c39c JN |
16 | - [ ] Choice of video players |
17 | - [ ] Show video URLs or not | |
18 | - [ ] Play audio only | |
19 | - [ ] Pagination of search results | |
44978125 JN |
20 | |
21 | ## Usage | |
22 | ||
c4aeb618 | 23 | Download the latest build from GitlabCI |
44978125 | 24 | |
c4aeb618 JN |
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 | |
44978125 JN |
31 | |
32 | ```sh | |
68fd8100 | 33 | ./clitube emacs |
44978125 | 34 | |
68fd8100 | 35 | ./clitube 'nim lang' |
44978125 JN |
36 | ``` |
37 | ||
c4aeb618 | 38 | ## Development |
44978125 | 39 | |
c4aeb618 | 40 | ### Compiling and Running |
44978125 JN |
41 | |
42 | ```sh | |
68fd8100 | 43 | nim c -d:ssl -r clitube.nim emacs |
44978125 | 44 | |
c4aeb618 | 45 | # If your search query has multiple words, use quotes |
68fd8100 | 46 | nim c -d:ssl -r clitube.nim 'nim lang' |
44978125 | 47 | ``` |
c4aeb618 JN |
48 | |
49 | ### Creating a release artifact | |
50 | ||
51 | ```sh | |
68fd8100 JN |
52 | nim c -d:ssl -d:release clitube.nim |
53 | ``` |