Add a cute screenshot

[nimcoon.git] / README.md

# CLI Tube

Play videos from YouTube (and maybe other sources in the future) from the
command line using your preferred desktop media player.

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
- [ ] Configuration options
    - [ ] Choice of video players
    - [ ] Show video URLs or not
    - [ ] Play audio only
- [ ] Pagination of search results

## Usage

Download the latest build from GitlabCI

```sh
wget https://gitlab.com/njoseph/cli-tube/-/jobs/artifacts/master/download?job=compile -O artifacts.zip
unzip artifacts.zip
```

Run the binary

```sh
./clitube emacs

./clitube 'nim lang'
```

## Development

### Compiling and Running

```sh
nim c -d:ssl -r clitube.nim emacs

# If your search query has multiple words, use quotes
nim c -d:ssl -r clitube.nim 'nim lang'
```

### Creating a release artifact

```sh
nim c -d:ssl -d:release clitube.nim
```