Skip to content

Latest commit

 

History

History
105 lines (65 loc) · 2.83 KB

README.md

File metadata and controls

105 lines (65 loc) · 2.83 KB
Raw

Vivace

Table of Contents
  1. About The Project
  2. Build From Source
  3. Usage
  4. Examples
  5. Contributing
  6. License
  7. Contact

About The Project

Command line tool in Rust to download songs from Youtube to whatever encoding you want

Note: ffmpeg needs to be present on your system

(back to top)

Build from source

To build the project from source, run cargo build --release within the project directory

(back to top)

Usage

vivace [OPTIONS] --url <URL> --output-file <OUTPUT_FILE>

Options:
  -u, --url <URL>                  Video URL
  -o, --output-file <OUTPUT_FILE>  Output file name
  -c, --chunk-size <CHUNK_SIZE>    Chunk size for partial requests
  -h, --help                       Print help
  -V, --version                    Print version

(back to top)

Examples

Download a song to given output file with .mp3 extension

vivace --url https://www.youtube.com/watch?v=dQw4w9WgXcQ --output-file my-favourite-song.mp3

Download a song to given output file with .wav extension

vivace --url https://www.youtube.com/watch?v=dQw4w9WgXcQ --output-file my-favourite-song.wav

Download a song to given output file and specify chunk size (in bytes) for the partial requests to the server

vivace --url https://www.youtube.com/watch?v=dQw4w9WgXcQ --output-file my-favourite-song.mp3 -c 10240

(back to top)

Contributing

Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Pavlos Smith - paulsmith4561+at+gmail.com

(back to top)