Plan for some more features
[nimcoon.git] / 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 - [x] Stream videos
15 - [x] Stream music
16 - [ ] Download video
17 - [ ] Download music
18 - [ ] Configuration options
19 - [ ] Play magnet links
20
21 ## Installation
22
23 Download the latest build from GitlabCI (amd64 GNU/Linux only).
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
31 For other platforms, create a release artifact using the following command:
32
33 ```sh
34 nim c -d:ssl -d:release clitube.nim
35 ```
36
37 Copy the binary to a directory on your PATH such as `/usr/local/bin`
38
39 ## Usage
40
41 ```sh
42 clitube emacs
43
44 # If your search query has multiple words, use quotes
45 clitube 'nim lang'
46
47 # Advanced: Play audio of the first search result
48 clitube -m -l "counting stars"
49 ```
50
51 ### Commandline arguments
52
53 | **Arguments** | **Explanation** |
54 |---------------|--------------------------------------------|
55 | -m, --music | Play Music only, no video |
56 | -l, --lucky | Try your luck with the first search result |
57
58 ## Development
59
60 One-liner for compiling and running
61
62 ```sh
63 nim c -d:ssl -r clitube.nim 'nim lang'
64 ```