starred/youtube-dl-ytdl-org

Fork 0

mirror of https://github.com/ytdl-org/youtube-dl.git synced 2026-03-02 19:17:00 -05:00

Add prompt information for zsh completions #25207

New issue

Open

opened 2026-02-21 13:42:13 -05:00 by deekerman · 2 comments

deekerman commented

2026-02-21 13:42:13 -05:00

Owner

Originally created by @Freed-Wu on GitHub (Apr 26, 2022).

Checklist

I'm reporting a feature request
I've verified that I'm running youtube-dl version 2021.12.17
I've searched the bugtracker for similar feature requests including closed ones

Description

WRITE DESCRIPTION HERE

Now, the completion of youtube-dl is: (e.g. zsh)

❯ youtube-dl --<Tab>
--abort-on-error                 --dump-pages                     --hls-prefer-native              --no-continue                    --rm-cache-dir
...

How about:

❯ youtube-dl --<Tab>
option
--abort-on-error                  Abort downloading of further videos (in the playlist or the command line) if an error occurs
--abort-on-unavailable-fragment   Abort downloading when some fragment is not available
...

It is just

#compdef youtube-dl

compdef _gnu_generic youtube-dl

I believe if use youtube-dl --completion zsh to generate a shell script, it can be done better.

Originally created by @Freed-Wu on GitHub (Apr 26, 2022).  ## Checklist  - [x] I'm reporting a feature request - [x] I've verified that I'm running youtube-dl version **2021.12.17** - [x] I've searched the bugtracker for similar feature requests including closed ones ## Description  WRITE DESCRIPTION HERE Now, the completion of youtube-dl is: (e.g. zsh) ``` ❯ youtube-dl --<Tab> --abort-on-error --dump-pages --hls-prefer-native --no-continue --rm-cache-dir ... ``` How about: ``` ❯ youtube-dl --<Tab> option --abort-on-error Abort downloading of further videos (in the playlist or the command line) if an error occurs --abort-on-unavailable-fragment Abort downloading when some fragment is not available ... ``` It is just ``` #compdef youtube-dl compdef _gnu_generic youtube-dl ``` I believe if use `youtube-dl --completion zsh` to generate a shell script, it can be done better.

deekerman added the

request

label

2026-02-21 13:42:13 -05:00

deekerman commented

2026-02-21 13:42:14 -05:00

Author

Owner

@dirkf commented on GitHub (Apr 27, 2022):

My expertise only goes as far as https://github.com/zsh-users/zsh-completions, but yt-dl has a GNU-like --help. Although yt-dl has a zsh completion, what happens with this?

compdef _gnu_generic youtube-dl

@dirkf commented on GitHub (Apr 27, 2022): My expertise only goes as far as https://github.com/zsh-users/zsh-completions, but yt-dl has a GNU-like `--help`. Although yt-dl has a zsh completion, what happens with this? ```zsh compdef _gnu_generic youtube-dl ```

deekerman commented

2026-02-21 13:42:15 -05:00

Author

Owner

@Freed-Wu commented on GitHub (Aug 8, 2022):

compdef _gnu_geneirc XXX is just a fallback solution, it use zsh to parse XXX --help to get a completion, but it is slow than the provided completion script. And it cannot provide higher functions, such as:

❯ youtube-dl --convert-subs <Tab>
selection
ass  lrc  srt  vtt
❯ youtube-dl --proxy <Tab>
URL
file:      ftp://     gopher://  http://    https://

@Freed-Wu commented on GitHub (Aug 8, 2022): `compdef _gnu_geneirc XXX` is just a fallback solution, it use zsh to parse `XXX --help` to get a completion, but it is slow than the provided completion script. And it cannot provide higher functions, such as: ``` ❯ youtube-dl --convert-subs <Tab> selection ass lrc srt vtt ❯ youtube-dl --proxy <Tab> URL file: ftp:// gopher:// http:// https:// ```

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

starred/youtube-dl-ytdl-org#25207

No description provided.

Rows
Columns