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