Add dependencies list
[nimcoon.git] / README.md
CommitLineData
726cf1a7 1# CLI Tube
726cf1a7 2
3e3ba843 3Play videos from YouTube and PeerTube from the
44978125
JN
4command line using your preferred desktop media player.
5
a6c167a7
JN
6This application is implemented in [Nim language](https://nim-lang.org) using
7only 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 14- [x] Stream videos
4827df7a 15- [x] Stream music
91e4d88b
JN
16- [ ] Download video
17- [ ] Download music
44978125 18- [ ] Configuration options
91e4d88b 19- [ ] Play magnet links
44978125 20
3f6de5cb 21## Installation
44978125 22
7d08d1af
JN
23CLI Tube depends on the following:
24- youtube-dl
25- mpv (recommended) or vlc
26
3f6de5cb 27Download the latest build from GitlabCI (amd64 GNU/Linux only).
44978125 28
c4aeb618
JN
29```sh
30wget https://gitlab.com/njoseph/cli-tube/-/jobs/artifacts/master/download?job=compile -O artifacts.zip
31unzip artifacts.zip
32```
33
44978125 34
3f6de5cb 35For other platforms, create a release artifact using the following command:
44978125 36
3f6de5cb
JN
37```sh
38nim c -d:ssl -d:release clitube.nim
44978125
JN
39```
40
3f6de5cb 41Copy the binary to a directory on your PATH such as `/usr/local/bin`
44978125 42
3f6de5cb 43## Usage
44978125
JN
44
45```sh
3f6de5cb 46clitube emacs
44978125 47
c4aeb618 48# If your search query has multiple words, use quotes
3f6de5cb 49clitube 'nim lang'
f135dfc7
JN
50
51# Advanced: Play audio of the first search result
52clitube -m -l "counting stars"
44978125 53```
c4aeb618 54
4827df7a
JN
55### Commandline arguments
56
f135dfc7
JN
57| **Arguments** | **Explanation** |
58|---------------|--------------------------------------------|
59| -m, --music | Play Music only, no video |
60| -l, --lucky | Try your luck with the first search result |
4827df7a 61
3f6de5cb
JN
62## Development
63
64One-liner for compiling and running
c4aeb618
JN
65
66```sh
3f6de5cb 67nim c -d:ssl -r clitube.nim 'nim lang'
68fd8100 68```