Scroll to navigation

ytcc(1) ytcc - a subscription wrapper for youtube-dl ytcc(1)

NAME

ytcc - a subscription wrapper for youtube-dl playlists

SYNOPSIS

ytcc [OPTIONS...] COMMAND [ARGS...]

DESCRIPTION

Ytcc - the (not only) YouTube channel checker.

Ytcc "subscribes" to playlists (supported by youtube-dl) and tracks new videos published to those playlists.

To show the detailed help of a COMMAND run `ytcc COMMAND --help`.

OPTIONS

-c, --conf FILE

Override configuration file.

-l, --loglevel [critical|info|debug]

Set the log level. Overrides the log level configured in the config file. [default: info]

-o, --output [json|table|xsv|rss]

Set output format. `json` prints in JSON format, which is usually not filtered by --attribute options of commands. `table` prints a human readable table. `xsv` prints x-separated values, where x can be set with the -s option. `rss` prints a RSS 2.0 feed of videos. [default: table]

-s, --separator TEXT

Set the delimiter used in XSV format. [default: ,]

--version

Show the version and exit.

--help

Show help and exit.

COMMANDS

subscribe [OPTIONS] NAME URL

Subscribe to a playlist.

The NAME argument is the name used to refer to the playlist. The URL argument is the URL to a playlist that is supported by youtube-dl.

OPTIONS:

--help Show command help and exit.

unsubscribe [OPTIONS] NAME

Unsubscribe from a playlist.

Unsubscribes from the playlist identified by NAME.

OPTIONS:

--yes Confirm the action without prompting.

--help Show command help and exit.

rename [OPTIONS] OLD NEW

Rename a playlist.

Renames the playlist OLD to NEW.

OPTIONS:

--help Show command help and exit.

subscriptions [OPTIONS]

List all subscriptions.

OPTIONS:

-a, --attributes COMMA_SEPARATED_VALUES Attributes of the playlist to be included in the output. Some of [name, url, tags].

--help Show command help and exit.

tag [OPTIONS] NAME [TAGS]...

Set tags of a playlist.

Sets the TAGS associated with the playlist called NAME. If no tags are given, all tags are removed from the given playlist.

OPTIONS:

--help Show command help and exit.

update [OPTIONS]

Check if new videos are available.

Downloads metadata of new videos (if any) without playing or downloading the videos.

OPTIONS:

-f, --max-fail INTEGER Number of failed updates before a video is not checked for updates any more.

-b, --max-backlog INTEGER Number of videos in a playlist that are checked for updates.

--help Show command help and exit.

list [OPTIONS]

List videos.

Lists videos that match the given filter options. By default, all unwatched videos are listed.

OPTIONS:

-a, --attributes COMMA_SEPARATED_VALUES Attributes of videos to be included in the output. Some of [id, url, title, description, publish_date, watched, duration, extractor_hash, playlists].

-c, --tags COMMA_SEPARATED_VALUES Listed videos must be tagged with one of the given tags.

-s, --since [%Y-%m-%d] Listed videos must be published after the given date.

-t, --till [%Y-%m-%d] Listed videos must be published before the given date.

-p, --playlists COMMA_SEPARATED_VALUES Listed videos must be in on of the given playlists.

-i, --ids COMMA_SEPARATED_VALUES Listed videos must have the given IDs.

-w, --watched Only watched videos are listed.

-u, --unwatched Only unwatched videos are listed.

-o, --order-by <CHOICE CHOICE>... Set the column and direction to sort listed videos.

--help Show command help and exit.

ls [OPTIONS]

List IDs of unwatched videos in XSV format.

Basically an alias for `ytcc --output xsv list --attributes id`. This alias can be useful for piping into the download, play, and mark commands. E.g: `ytcc ls | ytcc watch`

OPTIONS:

-c, --tags COMMA_SEPARATED_VALUES Listed videos must be tagged with one of the given tags.

-s, --since [%Y-%m-%d] Listed videos must be published after the given date.

-t, --till [%Y-%m-%d] Listed videos must be published before the given date.

-p, --playlists COMMA_SEPARATED_VALUES Listed videos must be in on of the given playlists.

-i, --ids COMMA_SEPARATED_VALUES Listed videos must have the given IDs.

-w, --watched Only watched videos are listed.

-u, --unwatched Only unwatched videos are listed.

-o, --order-by <CHOICE CHOICE>... Set the column and direction to sort listed videos.

--help Show command help and exit.

tui [OPTIONS]

Start an interactive terminal user interface.

OPTIONS:

-c, --tags COMMA_SEPARATED_VALUES Listed videos must be tagged with one of the given tags.

-s, --since [%Y-%m-%d] Listed videos must be published after the given date.

-t, --till [%Y-%m-%d] Listed videos must be published before the given date.

-p, --playlists COMMA_SEPARATED_VALUES Listed videos must be in on of the given playlists.

-i, --ids COMMA_SEPARATED_VALUES Listed videos must have the given IDs.

-w, --watched Only watched videos are listed.

-u, --unwatched Only unwatched videos are listed.

-o, --order-by <CHOICE CHOICE>... Set the column and direction to sort listed videos.

--help Show command help and exit.

play [OPTIONS] [IDS]...

Play videos.

Plays the videos identified by the given video IDs. If no IDs are given, ytcc tries to read IDs from stdin. If no IDs are given and no IDs were read from stdin, all unwatched videos are played.

OPTIONS:

-a, --audio-only Play only the audio track.

-i, --no-meta Don't print video metadata and description.

-m, --no-mark Don't mark the video as watched after playing it.

--help Show command help and exit.

mark [OPTIONS] [IDS]...

Mark videos as watched.

Marks videos as watched without playing or downloading them. If no IDs are given, ytcc tries to read IDs from stdin. If no IDs are given and no IDs were read from stdin, no videos are marked as watched.

OPTIONS:

--help Show command help and exit.

unmark [OPTIONS] [IDS]...

Mark videos as unwatched.

Marks videos as unwatched. If no IDs are given, ytcc tries to read IDs from stdin. If no IDs are given and no IDs were read from stdin, no videos are marked as watched.

OPTIONS:

--help Show command help and exit.

download [OPTIONS] [IDS]...

Download videos.

Downloads the videos identified by the given video IDs. If no IDs are given, ytcc tries to read IDs from stdin. If no IDs are given and no IDs were read from stdin, all unwatched videos are downloaded.

OPTIONS:

-p, --path DIRECTORY Set the download directory.

-a, --audio-only Download only the audio track.

-m, --no-mark Don't mark the video as watched after downloading it.

--help Show command help and exit.

cleanup [OPTIONS]

Remove all watched videos from the database.

WARNING!!! This removes all metadata of watched, marked as watched, and downloaded videos from ytcc's database. This cannot be undone! In most cases you won't need this command, but it is useful to keep the database size small.

OPTIONS:

-k, --keep INTEGER Number of videos to keep. Defaults to the max_update_backlog setting.

--yes Confirm the action without prompting.

--help Show command help and exit.

import [OPTIONS] FILE

Import YouTube subscriptions from OPML file.

You can export your YouTube subscriptions at https://www.youtube.com/subscription_manager.

OPTIONS:

--help Show command help and exit.

bug-report [OPTIONS]

Show debug information for bug reports.

Shows versions of dependencies and configuration relevant for any bug report. Please include the output of this command when filing a new bug report!

OPTIONS:

--help Show command help and exit.

SEE ALSO

mpv(1), youtube-dl(1)

Project homepage

https://github.com/woefe/ytcc

Bug Tracker

https://github.com/woefe/ytcc/issues

Feb 2021 2.1.0