Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ivanjermakov/ytm
YouTube video manager TUI
https://github.com/ivanjermakov/ytm
Last synced: 6 days ago
JSON representation
YouTube video manager TUI
- Host: GitHub
- URL: https://github.com/ivanjermakov/ytm
- Owner: ivanjermakov
- License: mit
- Created: 2022-01-21T18:33:04.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-06-11T22:32:01.000Z (5 months ago)
- Last Synced: 2024-06-12T16:10:19.724Z (5 months ago)
- Language: Haskell
- Size: 119 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ytm
YouTube video manager TUI
## Setup
### Required programs
- Stack
- curl
- [yt-dlp](https://github.com/yt-dlp/yt-dlp)
### Running
1. `git clone https://github.com/ivanjermakov/ytm`
2. Create file `~/.config/ytm/.env`:
```
API_KEY=
CLIENT_ID=
CLIENT_SECRET=
REFRESH_TOKEN=
```
4. `stack build`
### Obtaining API credentials
#### Obtaining `API_KEY`, `CLIENT_ID`, `CLIENT_SECRET`
You have to create a project in a [Google Cloud Console](https://console.cloud.google.com/). More
details [here](https://developers.google.com/youtube/registering_an_application).
#### Obtaining `REFRESH_TOKEN`
You need to have `CLIENT_ID` and `CLIENT_SECRET` obtained before.
1. Request `CODE` with `CLIENT_ID`
```
https://accounts.google.com/o/oauth2/v2/auth?client_id=CLIENT_ID&redirect_uri=urn:ietf:wg:oauth:2.0:oob&scope=https://www.googleapis.com/auth/youtube&response_type=code
```
2. Request `REFRESH_TOKEN` with `CODE`, `CLIENT_ID` and `CLIENT_SECRET`
```
curl -s \
--request POST \
--data "code=CODE&client_id=CLIENT_ID&client_secret=CLIENT_SECRET&redirect_uri=urn:ietf:wg:oauth:2.0:oob&grant_type=authorization_code" \
https://accounts.google.com/o/oauth2/token
```
## Configuration
ytm uses two configuration files:
- `.env` - stores API credentials
- `config.yml` - user config
`config.yml` example:
```
ytm:
fetchDays: 4,
videosDumpPath: /home/USER/.cache/videos.dump
channelsDumpPath: /home/USER/.cache/channels.dump
downloadedPath: /home/USER/Videos/
downloadCommandPattern: yt-dlp %s -o '%%(id)s.%%(ext)s' -P '%s' -O '%%(id)s.%%(ext)s' --progress --newline --no-simulate
playCommandPattern: mpv %s
```
By default, ytm will lookup those files in `$HOME/.config/ytm/` directory
Do not modify existing `yt-dlp` flags as it might mess up file download and progress reporting