Overscribe

Usage

Fetch all collections

overscribe collections fetch

Fetch specific collection(s)

overscribe collections fetch "The collections name starts with this"

List configured collections

overscribe collections list

Fetch medias behind one URL

Basic

overscribe oneshot \
  --profile "video hd" \
  https://example.com/video

overscribe will fetch medias pointed by URL using options specified in the profile, including the target directory, defined in config file.

With collection

If you want to fetch one URL as a collection:

overscribe oneshot \
  --profile audio:album \
  --collection "Worakls/Sur le front des animaux menacés" \
  https://www.youtube.com/playlist?list=OLAK5uy_mrpr_HvIdIey7xvzt82EPKRHsuorKOMM4

This --collection option will:

append the collection name to the target directory
generate a overscribe.yaml config file into target directory

overscribe help

Setup

Create a configuration file in ~/.config/overscribe.yaml like:

---
profiles:
  audio:
    directory: '~/Music'
    youtubedl_args: ['--format', 'bestaudio', '--extract-audio']
  audio:album:
    directory: '~/Music'
    youtubedl_args: ['--format', 'bestaudio', '--extract-audio']
    filename_pattern: '%(playlist_index)s. %(title)s.%(ext)s'
  video hd:
    directory: '~/Videos'
    youtubedl_args: ['--format' 'bestvideo+bestaudio']
  video:interview:
    directory: '~/Videos'
    youtubedl_args: ['--format', 'bestvideo[height<800]+bestaudio']
    filename_pattern: '%(upload_date)s - %(title)s.%(ext)s'

collections:
  "Thinkerview/Sciences":
    url: https://www.youtube.com/playlist?list=PLnRz6CkWwLlKnn_ggkzcvaBzmZjOoefJP
    profile: video:interview

YoutubeDL

Overscribe relies on youtube-dl.

In configuration file, youtubedl_args and filename_pattern options should be set according to youtube-dl documentation

Contributing

Pull requests are welcome on GitHub at https://github.com/neomilium/overscribe.

License

The gem is available as open source under the terms of the MIT License.