Add option to play music only
[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
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
3f6de5cb 16- [ ] Download videos
44978125 17- [ ] Configuration options
a000c39c
JN
18 - [ ] Choice of video players
19 - [ ] Show video URLs or not
20 - [ ] Play audio only
21- [ ] Pagination of search results
44978125 22
3f6de5cb 23## Installation
44978125 24
3f6de5cb 25Download the latest build from GitlabCI (amd64 GNU/Linux only).
44978125 26
c4aeb618
JN
27```sh
28wget https://gitlab.com/njoseph/cli-tube/-/jobs/artifacts/master/download?job=compile -O artifacts.zip
29unzip artifacts.zip
30```
31
44978125 32
3f6de5cb 33For other platforms, create a release artifact using the following command:
44978125 34
3f6de5cb
JN
35```sh
36nim c -d:ssl -d:release clitube.nim
44978125
JN
37```
38
3f6de5cb 39Copy the binary to a directory on your PATH such as `/usr/local/bin`
44978125 40
3f6de5cb 41## Usage
44978125
JN
42
43```sh
3f6de5cb 44clitube emacs
44978125 45
c4aeb618 46# If your search query has multiple words, use quotes
3f6de5cb 47clitube 'nim lang'
44978125 48```
c4aeb618 49
4827df7a
JN
50### Commandline arguments
51
52|----------------|---------------------------|
53| ***Arguments** | **Explanation** |
54|----------------|---------------------------|
55| -m, --music | Play Music only, no video |
56|----------------|---------------------------|
57
3f6de5cb
JN
58## Development
59
60One-liner for compiling and running
c4aeb618
JN
61
62```sh
3f6de5cb 63nim c -d:ssl -r clitube.nim 'nim lang'
68fd8100 64```