Giter Site home page Giter Site logo

timmikeladze / super-yt-mp3 Goto Github PK

View Code? Open in Web Editor NEW
1.0 3.0 0.0 200 KB

CLI tools for converting YouTube videos to MP3 files. Extract timestamps from video chapters, description, comments and automatically splits output into appropriately named files.

License: MIT License

JavaScript 20.29% TypeScript 79.71%
youtube youtube-downloader mp3 youtube-mp3 timestamps chapters

super-yt-mp3's Introduction

super-yt-mp3

CLI tools for converting YouTube videos to MP3 files. Extract timestamps from video chapters, description, comments then splits output into appropriately named files. Automatically adds ID3 tags to the files.

Installation

npx super-yt-mp3@latest

Note: ffmpeg is required.

Usage

Options:
  -ar, --artist <artist>   Name of the artist(s). If not specified, the artist will be extracted from the title.
  -al --album <album>      Name of the album. If not specified, the album will be extracted from the title.
  -f, --format <format>    Naming format of tracks. For example `%artist% - %album% - %track% - %title%` or `%track - %title%`.
  -na, --no-art            Skip downloading album art.
  -nc, --no-chapters       Skip splitting output into chapters.
  -ni, --no-id3            Skip adding ID3 tags to the output files. Only works with MP3 files.
  -nm, --no-mp3            Skip converting output to mp3. Useful for downloading video. Album art will not be downloaded.
  -kv --keep-video         Keep the original video file.
  -o, --output <path>      Output directory path. Required.
  -q, --quality <quality>  Quality of YouTube video. Defaults to highest quality.
  -u, --url <url>          URL of YouTube video. Required.
  -h, --help               display help for command

Examples

Download a video and splits it into individual mp3 files based on the video's chapters.

npx super-yt-mp3 -o ~/Downloads -u "url"

Download a video and converts into a single mp3 file.

npx super-yt-mp3 -o ~/Downloads -u "url" -nc

Download a video as a single mp4 file.

npx super-yt-mp3 -o ~/Downloads -u "url" -nm -nc -kv 

How to run tests

Provide a URL to a video and run the following command.

URL="video url" yarn jest

Note: The jest timeout is set to 60 seconds. A larger file or slow internet connection may cause the test to fail.

TODO

  • Provide timestamps via command line arguments
  • Loading indicators
  • Prompts for confirming metadata before downloading file

super-yt-mp3's People

Contributors

dependabot[bot] avatar renovate-bot avatar timmikeladze avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

super-yt-mp3's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

  • chore(deps): update dependency typescript to v5
  • fix(deps): update dependency commander to v10
  • fix(deps): update dependency get-youtube-chapters to v2

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

npm
package.json
  • @freetube/yt-comment-scraper 6.1.0
  • commander 9.2.0
  • fluent-ffmpeg 2.1.2
  • get-artist-title 1.3.1
  • get-youtube-chapters 1.1.0
  • isomorphic-fetch 3.0.0
  • node-id3 0.2.3
  • ytdl-core 4.11.0
  • @types/fluent-ffmpeg 2.1.20
  • @types/jest 27.5.0
  • @typescript-eslint/eslint-plugin 5.22.0
  • @typescript-eslint/parser 5.22.0
  • eslint 8.14.0
  • eslint-config-standard 16.0.3
  • eslint-plugin-import 2.26.0
  • eslint-plugin-node 11.1.0
  • eslint-plugin-promise 6.0.0
  • husky 7.0.4
  • jest 27.5.1
  • lint-staged 12.4.1
  • microbundle 0.15.0
  • ts-jest 27.1.4
  • typescript 4.6.4

  • Check this box to trigger a request for Renovate to run again on this repository

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.