# CLI Tube
-Play videos from YouTube (and maybe other sources in the future) from the
+Play videos from YouTube and PeerTube from the
command line using your preferred desktop media player.
-This application is implemented in [Nim language](https://nim-lang.org).
+This application is implemented in [Nim language](https://nim-lang.org) using
+only the standard library.
+
+![clitube screenshot with search term 'baby yoda'](screenshot.png)
## Features
- [x] Search for videos using keywords
-- [ ] Download or watch videos
+- [x] Stream videos
+- [x] Stream music
+- [ ] Download video
+- [ ] Download music
- [ ] Configuration options
+- [ ] Play magnet links
-## Usage
+## Installation
+
+Download the latest build from GitlabCI (amd64 GNU/Linux only).
+
+```sh
+wget https://gitlab.com/njoseph/cli-tube/-/jobs/artifacts/master/download?job=compile -O artifacts.zip
+unzip artifacts.zip
+```
+
+
+For other platforms, create a release artifact using the following command:
-### As a script
+```sh
+nim c -d:ssl -d:release clitube.nim
+```
-You must have nim installed locally for this to work.
+Copy the binary to a directory on your PATH such as `/usr/local/bin`
+
+## Usage
```sh
-nim c -d:ssl -r cli_tube.nim emacs
+clitube emacs
# If your search query has multiple words, use quotes
-nim c -d:ssl -r cli_tube.nim 'nim lang'
+clitube 'nim lang'
+
+# Advanced: Play audio of the first search result
+clitube -m -l "counting stars"
```
-### Using the binary
+### Commandline arguments
-Please use the binary in the repository for now.
-Will setup GitLab CI to publish proper binaries later.
+| **Arguments** | **Explanation** |
+|---------------|--------------------------------------------|
+| -m, --music | Play Music only, no video |
+| -l, --lucky | Try your luck with the first search result |
-```sh
-./cli_tube emacs
+## Development
-./cli_tube 'nim lang'
+One-liner for compiling and running
+
+```sh
+nim c -d:ssl -r clitube.nim 'nim lang'
```