powershell-yt-dlp

https://github.com/mpb10/powershell-yt-dlp/

A PowerShell module and script used to operate the yt-dlp command line program.

Author: mpb10

September 6th 2024

v0.8.0

• INSTALLATION
• USAGE
• TESTS
• TO-DO
• CHANGE LOG
• ADDITIONAL NOTES

INSTALLATION

Script download link: https://github.com/mpb10/powershell-yt-dlp/archive/refs/tags/v0.8.0.zip

Dependencies:

• PowerShell 5.0 or greater

To Install:

1. Download the release .zip file and extract it to a folder.
2. Run the Install and upgrade powershell-yt-dlp shortcut. This will install the script to %USERPROFILE%\scripts\powershell-yt-dlp and create start menu shortcuts.

To Update:

1. Navigate to the %USERPROFILE%\scripts\powershell-yt-dlp\bin folder.
2. Run the Install and upgrade powershell-yt-dlp shortcut. This will update the script files and executables.

To Uninstall:

To uninstall this script and its shortcuts, open a PowerShell command prompt and run the following commands:

Import-Module -Force ([environment]::GetFolderPath('UserProfile') + '\scripts\powershell-yt-dlp\yt-dlp.psm1')
Uninstall-YtDlpScript -Path ([environment]::GetFolderPath('UserProfile') + '\scripts\powershell-yt-dlp')

To also remove the user-modified files in the etc\ folder, add the -Force flag to the end of the Uninstall-YtDlpScript command or simply delete the entirety of the %USERPROFILE%\scripts\powershell-yt-dlp folder.

USAGE

• This script installs to the %USERPROFILE%\scripts\powershell-yt-dlp folder.
• Files that are commonly modified by end-users are located in the etc\ directory.
  • video-url-list.txt contains a user-defined list of URL's to download using the respective shortcut or yt-dlp-download-video-url-list.ps1 script.
  • Each line should contain one URL.
  • The URL can be a specific video URL, a playlist URL, or even a Youtube channel URL.
  • List of supported sites to download from can be found here
• Files that are modified as a result of running the script are located in the var\ directory.
  • download-archive-video.txt contains a list of video ID's that are not to be downloaded again on subsequent runs of the script.
  • To re-download a video, copy the video's ID from its URL, use CTRL + F to search for it in the download-archive-video.txt file, and then remove that line.
• Script files, the yt-dlp executables, and ffmpeg executables are located in the bin\ directory.
  • The script files and the executables can be updated by running the Install and upgrade powershell-yt-dlp shortcut again, which will re-download the latest versions of each.

TESTS

For developers, to run the script's tests, execute the following commands:

git clone https://github.com/mpb10/powershell-yt-dlp.git ([environment]::GetFolderPath('MyDocuments') + '\powershell-yt-dlp')
Set-Location -Path ([environment]::GetFolderPath('MyDocuments') + '\powershell-yt-dlp')
git checkout 0.8.0
Import-Module -Force ([environment]::GetFolderPath('MyDocuments') + '\powershell-yt-dlp\yt-dlp.psm1')
Test-YtDlpAll -Branch '0.8.0'

TO-DO

1. Cleanup the existing code for the GUI menus and finish them.

CHANGE LOG

* v0.8.0 - September 7th, 2024
  * Updated the install instructions and commands.

* v0.7.0 - September 6th, 2024
  * Fixed install shortcut pathing.

* v0.6.0 - September 6th, 2024
  * Re-organized repository.
  * Updated usage of the 'Set-PathVariable' function.
  * Updated README.md formatting.
  * Updated documentation headers of scripts.
  * Replaced tabs with spaces.

* v0.5.0 - September 6th, 2024
  * Updated README.md with latest version.

* v0.4.0 - September 6th, 2024
  * Fixed issue with the usage of the 'Set-PathVariable' function.

* v0.3.0 - September 6th, 2024
  * Fixed download audio script downloading from video URL list file.
  * Added function to set the system PATH variable and added it to each download script.

* v0.2.0 - September 6th, 2024
  * Adjusted the default yt-dlp options for downloading audio so that metadata is embedded into the .mp3 file.
  * Adjusted the default yt-dlp output path for some video download functions in the PowerShell module.
  * Fixed a path in the README.

* v0.1.0 - September 4th, 2024
  * Initial version of the script.

ADDITIONAL NOTES

Please support the development of yt-dlp and ffmpeg. The programs yt-dlp and ffmpeg and their source code can be found at the following links:

https://github.com/yt-dlp/yt-dlp

https://www.ffmpeg.org/

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 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.