Add terminal colors!!!
[nimcoon.git] / README.md
CommitLineData
726cf1a7 1# CLI Tube
726cf1a7 2
44978125
JN
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
a000c39c
JN
13 - [ ] Choice of video players
14 - [ ] Show video URLs or not
15 - [ ] Play audio only
16- [ ] Pagination of search results
44978125
JN
17
18## Usage
19
c4aeb618 20Download the latest build from GitlabCI
44978125 21
c4aeb618
JN
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
44978125
JN
28
29```sh
c4aeb618 30./cli_tube emacs
44978125 31
c4aeb618 32./cli_tube 'nim lang'
44978125
JN
33```
34
c4aeb618 35## Development
44978125 36
c4aeb618 37### Compiling and Running
44978125
JN
38
39```sh
c4aeb618 40nim c -d:ssl -r cli_tube.nim emacs
44978125 41
c4aeb618
JN
42# If your search query has multiple words, use quotes
43nim c -d:ssl -r cli_tube.nim 'nim lang'
44978125 44```
c4aeb618
JN
45
46### Creating a release artifact
47
48```sh
49nim c -d:ssl -d:release cli_tube.nim
50```