Features

• Add and download videos to and from the queue #5
• Clear the queue #5
• See the title, duration and url's of videos in the queue #3
• Simple and helpful terminal output #17
• Add multiple urls at once
• A KISS project

Dependencies

The only dependencies should be:

• yt-dlp - A youtube-dl fork with additional features and fixes.
• Newsboat (optional) - Newsboat is an RSS/Atom feed reader for the text console. It’s an actively maintained fork of Newsbeuter.

Installation/Update

• Download via zip on this page or run this command in your terminal:

  git clone https://github.com/yt-boat/yt-boat.git

• In a terminal run:

  cd yt-boat && ./install.sh

  • Once it is finished it should print:

  Finished setting up

  To install it to newsboat as well also run:

  ./newsboat_install.sh

  or add the following to your newsboat config

   macro a set browser "yt-boat --add $1" ; open-in-browser ; set browser "exo-open --launch WebBrowser"
   macro d set browser "yt-boat --download" ; open-in-browser ; set browser "exo-open --launch WebBrowser"
   macro c set browser "yt-boat --clear" ; open-in-browser ; set browser "exo-open --launch WebBrowser"
   macro q set browser "yt-boat -qnb" ; open-in-browser ; set browser "exo-open --launch WebBrowser"
   macro h set browser "yt-boat -hnb" ; open-in-browser ; set browser "exo-open --launch WebBrowser"
  

  then run (dont need if updating)

   `echo -e "include ~/.config/newsboat/yt-boat" >> $XDG_CONFIG_HOME/newsboat/config` 
  

Usage options

• On the command line Usage: yt-boat [option] options:

  • add a Adds video ID to the queue
  • download d Downloads the videos in the queue
  • clear c Clears the queue
  • queue q Shows the urls in the queue
  • help h Shows this help message

• In Newsboat

  • <macro> a Adds current video's ID to queue
  • <macro> d Downloads the urls in the queue
  • <macro> c Clears the urls in the queue
  • <macro> q Shows the urls in the queue
  • <macro> h Shows this help message

Recomendations

• For ease of use, create an alias for yt-boat so you can run it as something that is easier to type.

  e.g. alias queue="yt-boat"

Typical usage

• On the command line
  • yt-boat a https://youtube.com/watch?v=xxxxxxxxxxx
  • yt-boat q if you want to see videos you have added
  • yt-boat d
  • or if you dont want to download the video, clear the queue
  • yt-boat c
• In Newsboat
  • The macro key is set to , as default
  • Navigate to the "article" as it is called in Newsboat which is a video from a feed
  • Press <macro> a to add the current video to the queue
    • eg. ,a
  • Do this for the videos you want to add to the queue
  • Once you have added the videos you want to the queue, check the queue by pressing <macro> q
  • Then press <macro> d and the videos will start downloading in the terminal window
  • After they have downloaded the queue will automatically be cleared
  • If you want to clear the queue at any point before downloading you need to:
    • Go to a feed
    • Press <macro> c

Found a bug?

Submit an issue here.

Contributing

• Want to solve a simpler issue? Have a look at the good first issue label.
• Want to request a feauture? Submit a feature request here.
• Want to add a feature and you have the solution? Great! Create a pull request

FAQ

• Q: X video wont download, why?
• A: yt-boat will work for any video site that yt-dlp can download, it does not download videos itself, if there is an issue with downloading videos submit a bug to https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#opening-an-issue. To see yt-dlp's FAQ go to https://github.com/yt-dlp/yt-dlp/wiki/FAQ
• Q: Adding a video to queue wont work?
• A: Make sure you have either selected a video in a feed by using arrow keys or are in a "article" (by pressing on enter from a feed)
• Q: I am getting Error: Queue file may not exist, see FAQ's
• A: For some reason the queue file may have been deleted, this program can't do that so it is probably for another reason. Just run the installer again.

Licence

yt-boat by flufficat is marked with CC0 1.0 Universal

This means that you can copy, modify, distribute and use the work even for commercial purposes, all without asking permission.