Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grkvlt/kimono-channel-access
Script wrapper for yt-dlp media downloader
https://github.com/grkvlt/kimono-channel-access
Last synced: 7 days ago
JSON representation
Script wrapper for yt-dlp media downloader
- Host: GitHub
- URL: https://github.com/grkvlt/kimono-channel-access
- Owner: grkvlt
- Created: 2023-09-13T16:21:27.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-31T00:19:35.000Z (11 months ago)
- Last Synced: 2024-10-16T20:51:59.871Z (about 1 month ago)
- Language: Shell
- Size: 15.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# K I M O N O . S H
> Version: 0.8.9
> Updated: 23 November 2023
Downloads video and audio files from [YouTube](https://youtu.be/) using
the _yt-dlp(1)_ utility.
## USAGE
```shell
$ kimono.sh --help
...
$ CONFIG="options" kimono.sh ids...
...
$ kimono.sh --options ids...
...
```
## ABOUT
This script can be called with different names to perform particular
functions. To download files using configuration values that are optimised
for specific types of content, the following script names have been
defined:
- youtube.sh:
Download videos as MP4 with qualty audio at up to 1080p resolution.
- podcast.sh:
Download a podcast with low quality video and decent audio.
- audio.sh:
Download the audio only as best quality MP3.
- video.sh:
Download videos with best overall quality.
## CONFIG
The following environment variables can be used to apply or override
configuration:
- `FORMAT`:
Configure the format to download directly, using the `yt-dlp`
format specifications. Use `--format-list` to get a list of the
available formats, and check the manual page and documentation
for `yt-dlp` itself for more in-depth information about creating
custom specifications.
- `QUALITY`:
Set different pre-defined format specifications.
- `SCRIPT`:
Enable different script functionality.
- `FRAGMENTS`:
Enable downloading multiple fragments in parallel.
- `PLAYLIST`:
Set the name of the file containing ids or urls.
- `TARGET`:
Set the target folder to save files to.
- `ORDER`:
Either **random** or **sequential** order for playlist downloads.
- `CONFIG`:
Additional configuration options for `yt-dlp`.
These variables can be set in the global shell environment to set
the base folder used for all file downloads of specific types:
- `MOVIES`:
Sets the target folder base for video files. Defaults to the
`~/Movies` folder.
- `MUSIC`:
Sets the target folder base for audio files. Defaults to the
`~/Music` folder.
These variables can be set to configure output logging:
- `DRYRUN`:
Display `yt-dlp` command without executing.
- `DEBUG`:
Enable script debug output. Set to _trace_ for full command logging.
- `QUIET`:
Only show progress of downloads.
- `VERBOSE`:
Verbose logging for `yt-dlp` process.
## OPTIONS
Various command-line options can be used in combination with the
environment variables above to configure operation. The following options
require a value to be specified:
- `--format` | `-F` | `-f` _format_ ; see `FORMAT`
- `--quality` | `-Q` | `-q` _quality_ ; see `QUALITY`
- `--script` | `-S` | `-s` _script_ ; see `SCRIPT`
- `--playlist` | `-P` | `-p` _filename_ ; see `PLAYLIST`
- `--fragments` _n_ ; see `FRAGMENTS`
- `--target` | `-T` | `-t` _folder_ ; see `TARGET`
- `--order` _order_ ; see `ORDER`
These options for debugging and output configuration do not need a value:
- `--debug` ; see `DEBUG`
- `--trace` ; see `DEBUG`
- `--dryrun` ; see `DRYRUN`
- `--quiet` ; see `QUIET`
- `--verbose` ; see `VERBOSE`
These options will execute portions of the script which provide additional
functionality. The script operates differently from its default behaviour,
but still uses the same shared variables and configuration:
- `--list-formats`:
List available formats for the video ids.
- `--javascript`:
Generate the JS code to create a playlist file from a YouTube mix.
- `--find-ids`:
Search for files in the target `Movies` folder by id.
- `--duplicates`:
Search the target `Movies` folder for files with the same id.
These options display usage, help or version information:
- `--usage`
- `--help` | `-h` | `-?`
- `--version` | `-v`
The configuration values set using environment variables will be overridden
by values set using the command-line options. So, the following command will
download the video into the `${MOVIES}/Lectures/MIT-1001/` target folder:
```shell
TARGET=Courses/MIT-1001 kimono.sh --target Lectures/MIT-1001 XXXXXXXX
```
## EXAMPLES
```shell
kimono.sh --format 18 -T Interesting/Science XXXXXXXX YYYYYYYY ZZZZZZZZ
FORMAT="139+340" FRAGMENTS="2" PLAYLIST="catalog.out" kimono.sh
kimono.sh --quality "podcast" XXXXXXXX
youtube.sh --order PPPPPPPPPPPPPPPP
audio.sh -P mixtape.txt
podcast.sh XXXXXXXX
video.sh --quiet XXXXXXXX
cut -d, -f2 videos.csv | youtube.sh
DEBUG=y SCRIPT=video kimono.sh XXXXXXXX
kimono.sh --list-formats --playlist "index.txt"
kimono.sh --find-ids XXXXXXXX YYYYYYYY
PLAYLIST="mixtape.txt" kimono.sh --javascript
kimono.sh --duplicates -T Recent
```
---
> Copyright: 2023 by Andrew Donald Kennedy
> License: CC BY-SA 4.0
> Author: [[email protected]](mailto:[email protected])
> Source: [grkvlt/kimono-channel-access](https://github.com/grkvlt/kimono-channel-access.git)