🔗 Table of Contents

• Features
  • Help Documentation Example
• Usage
• Examples
  • Simple
• Support & Assistance
• Contributing
• License

✨ Features

!!! NOTE: go-ytdlp isn't stable yet, and as such, there may be wide-reaching breaking changes, until 1.0.0 !!!

• CLI bindings for yt-dlp -- including all flags/commands.
• Optional Install and MustInstall helpers to auto-download the latest supported version of yt-dlp, including proper checksum validation for secure downloads.
  • Worry less about making sure yt-dlp is installed wherever go-ytdlp is running from!
• Carried over help documentation for all functions/methods.
• Flags with arguments have type mappings according to what the actual flags expect.
• Completely generated, ensuring it's easy to update to future yt-dlp versions.
• Deprecated flags are marked as deprecated in a way that should be caught by most IDEs/linters.
• Stdout/Stderr parsing, with timestamps, and optional JSON post-processing.

✨ Help Documentation Example

---

⚙️ Usage

go get -u github.com/lrstanley/go-ytdlp@latest

👏 Examples

Simple

See also _examples/simple/main.go, which includes writing results (stdout/stderr/etc) as JSON.

package main

import (
	"context"

	"github.com/lrstanley/go-ytdlp"
)

func main() {
	// If yt-dlp isn't installed yet, download and cache it for further use.
	ytdlp.MustInstall(context.TODO(), nil)

	dl := ytdlp.New().
		FormatSort("res,ext:mp4:m4a").
		RecodeVideo("mp4").
		Output("%(extractor)s - %(title)s.%(ext)s")

	_, err := dl.Run(context.TODO(), "https://www.youtube.com/watch?v=dQw4w9WgXcQ")
	if err != nil {
		panic(err)
	}
}

---

🙋‍♂️ Support & Assistance

• ❤️ Please review the Code of Conduct for guidelines on ensuring everyone has the best experience interacting with the community.
• 🙋‍♂️ Take a look at the support document on guidelines for tips on how to ask the right questions.
• 🐞 For all features/bugs/issues/questions/etc, head over here.

🤝 Contributing

• ❤️ Please review the Code of Conduct for guidelines on ensuring everyone has the best experience interacting with the community.
• 📋 Please review the contributing doc for submitting issues/a guide on submitting pull requests and helping out.
• 🗝️ For anything security related, please review this repositories security policy.

⚖️ License

MIT License

Copyright (c) 2023 Liam Stanley <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Also located here