docs: improve CLI help, shell completion, and README
- Add command groups (Getting Started, Search, Downloads, Daemon, System) - Add shell completion command (bash, zsh, fish, powershell) - Add flag completions for --type, --quality, --sort, --lang, --genre, --country, --method, --player - Improve Long descriptions and Examples for all commands - Split doctor disk check into platform-specific files (Unix/Windows) - Validate infoHash length before truncating (prevent panic) - Fix references to non-existent 'unarr daemon start' command - Move stats command to System & Diagnostics group - Rewrite README with complete documentation, correct config format (toml not yaml), all commands, shell completion section
This commit is contained in:
parent
197e33956a
commit
719429b06e
22 changed files with 973 additions and 119 deletions
|
|
@ -27,9 +27,14 @@ func newStreamCmd() *cobra.Command {
|
|||
cmd := &cobra.Command{
|
||||
Use: "stream <magnet|infohash>",
|
||||
Short: "Stream a torrent directly to a media player",
|
||||
Long: `Stream a torrent by info hash or magnet link.
|
||||
Downloads sequentially and serves the video over HTTP.
|
||||
Automatically opens mpv, vlc, or your browser.`,
|
||||
Long: `Stream a torrent by info hash or magnet link without waiting for the full download.
|
||||
|
||||
Downloads pieces sequentially (prioritizing the beginning of the file) and serves
|
||||
the video over a local HTTP server. Automatically detects and opens mpv, vlc, or
|
||||
your default browser.
|
||||
|
||||
The stream server runs until you press Ctrl+C. Data is stored temporarily in your
|
||||
download directory (or system temp if not configured).`,
|
||||
Example: ` unarr stream abc123def456abc123def456abc123def456abc1
|
||||
unarr stream "magnet:?xt=urn:btih:..." --port 8080
|
||||
unarr stream <hash> --player mpv
|
||||
|
|
@ -43,6 +48,9 @@ Automatically opens mpv, vlc, or your browser.`,
|
|||
cmd.Flags().IntVar(&port, "port", 0, "HTTP server port (default: random available)")
|
||||
cmd.Flags().BoolVar(&noOpen, "no-open", false, "don't open a player, just print the URL")
|
||||
cmd.Flags().StringVar(&playerCmd, "player", "", "media player command (default: auto-detect)")
|
||||
cmd.RegisterFlagCompletionFunc("player", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
|
||||
return []string{"mpv\tmpv media player", "vlc\tVLC media player"}, cobra.ShellCompDirectiveNoFileComp
|
||||
})
|
||||
|
||||
return cmd
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue