updated README
This commit is contained in:
56
README
56
README
@@ -4,42 +4,66 @@ viewing and interacting with YouTube videos.
|
||||
Dependencies:
|
||||
- curl(1)
|
||||
- jq(1)
|
||||
- mpv(1)
|
||||
- yt-dlp(1)
|
||||
|
||||
Variables:
|
||||
Environment Variables:
|
||||
$DEBUG
|
||||
- Set this variable to get debug output to stderr
|
||||
|
||||
$PLAYER
|
||||
- Set this variable to a video player that can utilize yt-dlp to playback
|
||||
videos from YouTube
|
||||
|
||||
$YTPICK
|
||||
- Set this variable to a dmenu-compatible picker for use with the pick
|
||||
subcommand.
|
||||
subcommand
|
||||
|
||||
$YT_PL_DIR
|
||||
- Set this variable to the directory where playlists should be stored; defaults
|
||||
to $XDG_DATA_HOME/yt
|
||||
|
||||
|
||||
Usage:
|
||||
yt add | archive | cache | clone | music | pick | play | queue | verify
|
||||
yt add | archive | cache | clone | list | localsearch | new | pick | play | queue | search | sync | verify
|
||||
|
||||
add uri file
|
||||
add uri playlist
|
||||
- Adds a video by URI to a playlist
|
||||
|
||||
archive uri...
|
||||
- Archives a video on the Wayback Machine
|
||||
- Archives videos on the Wayback Machine
|
||||
|
||||
cache uri...
|
||||
- Caches a video title
|
||||
cache video...
|
||||
- Caches video titles
|
||||
|
||||
clone uri file
|
||||
clone uri [playlist]
|
||||
- Clones a YouTube playlist to a file
|
||||
|
||||
music uri...
|
||||
- Downloads a video as audio, splitting it by chapter
|
||||
list
|
||||
- lists local playlists
|
||||
|
||||
pick file...
|
||||
localsearch
|
||||
- uses $YTPICK to search for videos from the local cache
|
||||
|
||||
new playlist...
|
||||
- creates new playlists
|
||||
|
||||
pick playlist...
|
||||
- Opens $PICKER to a list of videos in a file
|
||||
|
||||
play uri...
|
||||
- Plays a video, caching its title first
|
||||
- Plays videos, caching their titles first
|
||||
|
||||
queue file...
|
||||
- Queues a playlist
|
||||
queue playlist...
|
||||
- Queues playlists
|
||||
|
||||
verify file...
|
||||
search term [count]
|
||||
- Searches YouTube for term and returns count results
|
||||
|
||||
sync [playlist]
|
||||
- If a playlist is specified, sync that playlist with its remote YouTube
|
||||
counterpart; otherwise, sync all playlists with remotes
|
||||
|
||||
verify playlist...
|
||||
- Verifies that all the videos in a playlist are existent on YouTube, and if
|
||||
they aren’t, attempts to replace the URI with one from the Wayback Machine. If
|
||||
the video isn’t available on the Wayback Machine, it comments the video link. It
|
||||
|
||||
Reference in New Issue
Block a user