Add PeerTube support
[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
3f6de5cb 23Download the latest build from GitlabCI (amd64 GNU/Linux only).
44978125 24
c4aeb618
JN
25```sh
26wget https://gitlab.com/njoseph/cli-tube/-/jobs/artifacts/master/download?job=compile -O artifacts.zip
27unzip artifacts.zip
28```
29
44978125 30
3f6de5cb 31For other platforms, create a release artifact using the following command:
44978125 32
3f6de5cb
JN
33```sh
34nim c -d:ssl -d:release clitube.nim
44978125
JN
35```
36
3f6de5cb 37Copy the binary to a directory on your PATH such as `/usr/local/bin`
44978125 38
3f6de5cb 39## Usage
44978125
JN
40
41```sh
3f6de5cb 42clitube emacs
44978125 43
c4aeb618 44# If your search query has multiple words, use quotes
3f6de5cb 45clitube 'nim lang'
f135dfc7
JN
46
47# Advanced: Play audio of the first search result
48clitube -m -l "counting stars"
44978125 49```
c4aeb618 50
4827df7a
JN
51### Commandline arguments
52
f135dfc7
JN
53| **Arguments** | **Explanation** |
54|---------------|--------------------------------------------|
55| -m, --music | Play Music only, no video |
56| -l, --lucky | Try your luck with the first search result |
4827df7a 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```