Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lrstanley/go-ytdlp
yt-dlp cli bindings for Go
https://github.com/lrstanley/go-ytdlp
youtube-dl yt-dlp yt-dlp-wrapper
Last synced: about 1 month ago
JSON representation
yt-dlp cli bindings for Go
- Host: GitHub
- URL: https://github.com/lrstanley/go-ytdlp
- Owner: lrstanley
- License: mit
- Created: 2023-09-01T03:58:57.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-11-04T02:32:06.000Z (about 2 months ago)
- Last Synced: 2024-11-04T03:24:57.993Z (about 2 months ago)
- Topics: youtube-dl, yt-dlp, yt-dlp-wrapper
- Language: Go
- Homepage: https://pkg.go.dev/github.com/lrstanley/go-ytdlp
- Size: 962 KB
- Stars: 70
- Watchers: 3
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
## :link: Table of Contents
- [Features](#sparkles-features)
- [Help Documentation Example](#sparkles-help-documentation-example)
- [Usage](#gear-usage)
- [Examples](#clap-examples)
- [Simple](#simple)
- [Support & Assistance](#raising_hand_man-support--assistance)
- [Contributing](#handshake-contributing)
- [License](#balance_scale-license)
## :sparkles: 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.
### :sparkles: Help Documentation Example
---
## :gear: Usage
```console
go get -u github.com/lrstanley/go-ytdlp@latest
```
## :clap: Examples
### Simple
See also [_examples/simple/main.go](./_examples/simple/main.go), which includes
writing results (stdout/stderr/etc) as JSON.
```go
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)
}
}
```
---
## :raising_hand_man: Support & Assistance
* :heart: Please review the [Code of Conduct](.github/CODE_OF_CONDUCT.md) for
guidelines on ensuring everyone has the best experience interacting with
the community.
* :raising_hand_man: Take a look at the [support](.github/SUPPORT.md) document on
guidelines for tips on how to ask the right questions.
* :lady_beetle: For all features/bugs/issues/questions/etc, [head over here](https://github.com/lrstanley/go-ytdlp/issues/new/choose).
## :handshake: Contributing
* :heart: Please review the [Code of Conduct](.github/CODE_OF_CONDUCT.md) for guidelines
on ensuring everyone has the best experience interacting with the
community.
* :clipboard: Please review the [contributing](.github/CONTRIBUTING.md) doc for submitting
issues/a guide on submitting pull requests and helping out.
* :old_key: For anything security related, please review this repositories [security policy](https://github.com/lrstanley/go-ytdlp/security/policy).
## :balance_scale: License
```
MIT License
Copyright (c) 2023 Liam Stanley
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](LICENSE)_