Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mitsuki31/ytmp3-setup
Easy setup YTMP3 module for Unix-like system.
https://github.com/mitsuki31/ytmp3-setup
Last synced: about 2 months ago
JSON representation
Easy setup YTMP3 module for Unix-like system.
- Host: GitHub
- URL: https://github.com/mitsuki31/ytmp3-setup
- Owner: mitsuki31
- License: mit
- Created: 2024-07-27T18:20:17.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-07-27T18:46:17.000Z (6 months ago)
- Last Synced: 2024-07-28T19:58:32.546Z (6 months ago)
- Language: Shell
- Homepage:
- Size: 6.84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# YTMP3 Setup
**YTMP3 Setup** is a script designed to simplify the installation and configuration of the [YTMP3-JS] module, which allows downloading and converting YouTube videos to MP3 format. This project is tailored for Linux environments, including Termux on Android devices.
## Features
- **Automatic OS Detection**: Identifies the operating system to choose the appropriate installation method.
- **Node.js Installation**: Checks for Node.js and installs it if necessary, supporting versions 16 and newer.
- **Package Manager Support**: Uses `apt-get` on Linux systems, including Termux.
- **Global Installation**: Installs the [YTMP3-JS] module globally using npm.
- **Dry Run Option**: Provides a `--dry-run` flag for testing the script without making actual changes.
## Requirements
- **Operating System**: Linux (including Termux on Android).
- **Dependencies**: Node.js >= 16.
- **Permissions**: Sufficient permissions to install packages and modify system settings.
## Installation
> [!IMPORTANT]
> Make sure you've installed `curl` on your system. If not, Linux user can try this:
> ```bash
> apt-get install curl -y
> ```
```bash
curl -s https://raw.githubusercontent.com/mitsuki31/ytmp3-setup/master/setup.sh | bash
```
After installation, use the `ytmp3` command to download and convert YouTube videos to MP3 format.
For a list of options and commands, run:
```bash
ytmp3 -?
```
## License
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
[YTMP3-JS]: https://npmjs.com/package/ytmp3-js