]> njoseph.me Git - nimcoon.git/blame_incremental - README.md
Add terminal colors!!!
[nimcoon.git] / README.md
... / ...
CommitLineData
1# CLI Tube
2
3Play videos from YouTube (and maybe other sources in the future) from the
4command line using your preferred desktop media player.
5
6This 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
20Download the latest build from GitlabCI
21
22```sh
23wget https://gitlab.com/njoseph/cli-tube/-/jobs/artifacts/master/download?job=compile -O artifacts.zip
24unzip artifacts.zip
25```
26
27Run the binary
28
29```sh
30./cli_tube emacs
31
32./cli_tube 'nim lang'
33```
34
35## Development
36
37### Compiling and Running
38
39```sh
40nim c -d:ssl -r cli_tube.nim emacs
41
42# If your search query has multiple words, use quotes
43nim c -d:ssl -r cli_tube.nim 'nim lang'
44```
45
46### Creating a release artifact
47
48```sh
49nim c -d:ssl -d:release cli_tube.nim
50```