{"id":17834804,"url":"https://github.com/animmouse/setup-yt-dlp","last_synced_at":"2025-10-24T14:43:00.879Z","repository":{"id":65157424,"uuid":"401049363","full_name":"AnimMouse/setup-yt-dlp","owner":"AnimMouse","description":"Setup/Install yt-dlp (a youtube-dl fork) for GitHub Actions","archived":false,"fork":false,"pushed_at":"2024-12-17T07:10:29.000Z","size":65,"stargazers_count":14,"open_issues_count":0,"forks_count":7,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-28T03:01:41.926Z","etag":null,"topics":["action","actions","github-actions","youtube-dl","yt-dlp"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/setup-yt-dlp","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AnimMouse.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-08-29T13:31:42.000Z","updated_at":"2025-01-23T04:24:02.000Z","dependencies_parsed_at":"2023-01-13T15:43:09.160Z","dependency_job_id":"57ed60c1-5be9-4e15-8cf6-54da5dbcb7ba","html_url":"https://github.com/AnimMouse/setup-yt-dlp","commit_stats":{"total_commits":26,"total_committers":1,"mean_commits":26.0,"dds":0.0,"last_synced_commit":"adab6a56b5a75bb14ff74ad810a2d37678228b22"},"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnimMouse%2Fsetup-yt-dlp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnimMouse%2Fsetup-yt-dlp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnimMouse%2Fsetup-yt-dlp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnimMouse%2Fsetup-yt-dlp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AnimMouse","download_url":"https://codeload.github.com/AnimMouse/setup-yt-dlp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244010926,"owners_count":20383333,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["action","actions","github-actions","youtube-dl","yt-dlp"],"created_at":"2024-10-27T20:11:27.997Z","updated_at":"2025-10-24T14:42:55.837Z","avatar_url":"https://github.com/AnimMouse.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Setup yt-dlp for GitHub Actions\nSetup [yt-dlp](https://github.com/yt-dlp/yt-dlp) (a [youtube-dl](https://github.com/ytdl-org/youtube-dl) fork) on GitHub Actions to use `yt-dlp`.\n\nThis action installs [yt-dlp](https://github.com/yt-dlp/yt-dlp) for use in actions by installing it on tool cache using [AnimMouse/tool-cache](https://github.com/AnimMouse/tool-cache).\n\nThis action is implemented as a [composite](https://docs.github.com/en/actions/sharing-automations/creating-actions/creating-a-composite-action) action.\n\n## Usage\nTo use `yt-dlp`, run this action before `yt-dlp`.\n\n```yaml\nsteps:\n  - name: Setup yt-dlp\n    uses: AnimMouse/setup-yt-dlp@v3\n    \n  - run: yt-dlp https://www.youtube.com/watch?v=BaW_jenozKc\n```\n\n## FFmpeg\nTo improve yt-dlp's handling of formats, like [merging `bestvideo+bestaudio` instead of just using `best`](https://github.com/yt-dlp/yt-dlp/#strongly-recommended), it is recommended to install [FFmpeg](https://ffmpeg.org).\\\nBy default, this action will install FFmpeg automatically.\n\nFor Linux \u0026 Windows, this action will install [yt-dlp/FFmpeg-Builds](https://github.com/yt-dlp/FFmpeg-Builds) with some patches necessary for smooth integration with yt-dlp using `AnimMouse/setup-yt-dlp/ffmpeg@v3`.\\\nFor macOS, you need to run [AnimMouse/setup-ffmpeg](https://github.com/AnimMouse/setup-ffmpeg) first as yt-dlp/FFmpeg-Builds currently does not have macOS builds.\n\n### Disable\nIf you don't want to install FFmpeg automatically, set `ffmpeg` to `false`.\n\n```yaml\nsteps:\n  - name: Setup yt-dlp\n    uses: AnimMouse/setup-yt-dlp@v3\n    with:\n      ffmpeg: false\n```\n\n## aria2\nIt is recommended to use [aria2](https://aria2.github.io) as the downloader for yt-dlp, this will improve the downloading process and [aria2 is already preinstalled](https://github.com/actions/runner-images/issues/970) in GitHub Actions.\\\nBy default, this action will write to yt-dlp config to use aria2 automatically.\n\n### Disable\nIf you don't want to use aria2, set `aria2` to `false`.\n\n```yaml\nsteps:\n  - name: Setup yt-dlp\n    uses: AnimMouse/setup-yt-dlp@v3\n    with:\n      aria2: false\n```\n\n## YouTube cookies\nCurrently, YouTube requires data center IP addresses to be signed in.\\\nThe error `Sign in to confirm you’re not a bot. This helps protect our community. Learn more` appears.\n\nTo bypass this, use the `AnimMouse/setup-yt-dlp/cookies@v3` action to sign in and pass cookies.\\\nFollow the instructions at [yt-dlp wiki](https://github.com/yt-dlp/yt-dlp/wiki/Extractors#exporting-youtube-cookies) to get the cookies.txt file.\n\nEncode the cookies.txt file in Base64 using this command `base64 -w 0 cookies.txt` and paste it to the `YOUTUBE_COOKIES` secret.\n\n\u003e [!CAUTION]\n\u003e Do not use your personal account for cookies. Use a dummy account, and create a brand account inside of it, and use that to sign in. This passing the cookies method may result in your account being [blocked](https://github.com/yt-dlp/yt-dlp/issues/10085).\n\n```yaml\nsteps:\n  - name: Setup yt-dlp\n    uses: AnimMouse/setup-yt-dlp@v3\n    \n  - name: Setup yt-dlp YouTube cookies\n    uses: AnimMouse/setup-yt-dlp/cookies@v3\n    with:\n      cookies: ${{ secrets.YOUTUBE_COOKIES }}\n      \n  - run: yt-dlp https://www.youtube.com/watch?v=BaW_jenozKc\n```\n\nBy default, this action will write to yt-dlp config to pass cookies automatically\n\n### Disable\nIf you don't want to pass cookies automatically, set `enable` to `false`.\n\n```yaml\nsteps:\n  - name: Setup yt-dlp\n    uses: AnimMouse/setup-yt-dlp@v3\n    \n  - name: Setup yt-dlp YouTube cookies\n    uses: AnimMouse/setup-yt-dlp/cookies@v3\n    with:\n      cookies: ${{ secrets.YOUTUBE_COOKIES }}\n      enable: false\n      \n  - run: yt-dlp --cookies ~/.cache/yt-dlp/youtube/cookies.txt https://www.youtube.com/watch?v=BaW_jenozKc\n```\n\n### Update cookies\nCookies have expiration, which means it has to be refreshed, or else it will expire and it will not work anymore. To prevent expiration, yt-dlp automatically refreshes the cookies as needed.\\\nTo update those cookies in GitHub secrets, use the `AnimMouse/setup-yt-dlp/cookies/update@v3` action to update those cookies.\n\nThis requires a fine-grained personal access token that has read and write access to the secrets scope in the current repository to update the secret as the default `GITHUB_TOKEN` does not have access to the secrets scope.\n\n```yaml\nsteps:\n  - name: Setup yt-dlp\n    uses: AnimMouse/setup-yt-dlp@v3\n    \n  - name: Setup yt-dlp YouTube cookies\n    uses: AnimMouse/setup-yt-dlp/cookies@v3\n    with:\n      cookies: ${{ secrets.YOUTUBE_COOKIES }}\n      \n  - run: yt-dlp https://www.youtube.com/watch?v=BaW_jenozKc\n    \n  - name: Update yt-dlp YouTube cookies\n    uses: AnimMouse/setup-yt-dlp/cookies/update@v3\n    with:\n      cookies_secret_name: YOUTUBE_COOKIES\n      token: ${{ secrets.GH_PAT }}\n```\n\n### Specific version\nYou can specify the version you want. By default, this action downloads the latest version if the version is not specified.\n\n#### Specific stable\n```yaml\nsteps:\n  - name: Setup yt-dlp\n    uses: AnimMouse/setup-yt-dlp@v3\n    with:\n      version: 2022.02.04\n```\n\n#### Latest nightly\n```yaml\nsteps:\n  - name: Setup yt-dlp\n    uses: AnimMouse/setup-yt-dlp@v3\n    with:\n      nightly: true\n```\n\n#### Specific nightly\n```yaml\nsteps:\n  - name: Setup yt-dlp\n    uses: AnimMouse/setup-yt-dlp@v3\n    with:\n      version: 2024.02.04.232659\n      nightly: true\n```\n\n### GitHub token\nThis action automatically uses a GitHub token in order to authenticate with the GitHub API and avoid rate limiting. You can also specify your own read-only fine-grained personal access token.\n\n```yaml\nsteps:\n  - name: Setup yt-dlp\n    uses: AnimMouse/setup-yt-dlp@v3\n    with:\n      token: ${{ secrets.GH_PAT }}\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanimmouse%2Fsetup-yt-dlp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanimmouse%2Fsetup-yt-dlp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanimmouse%2Fsetup-yt-dlp/lists"}