aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 3cc76d492ae246939979d082cd01c86694a26637 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# yt-music

A command line YouTube Music client.

## Installation

```sh
pip install --upgrade yt-music
```

**NOTE** YOU NEED `PYTHON` INSTALLED AND IN YOUR `PATH`

## Dependencies

- [mpv](https://mpv.io) - Video/Audio player which doesn't suck
- [fzf](https://github.com/junegunn/fzf) - A command-line fuzzy finder

**NOTE** YOU NEED TO HAVE THEM IN YOUR `PATH`

## Config

Config file has to be in the following location depending on your OS:

- On Linux and Mac:
    `$HOME/.config/yt-music/config.json`

- On Windows:
    `C:\Users\<username>\.config\yt-music\config.json`

You can copy the example config `config.json.example`

## Usage

- Open a terminal

- Type:
    - `yt-music <your music you wanna listen>`
    
    or
    
    - `yt-music`