Package Exports

@thiagobrg60/ttkdl-cli
@thiagobrg60/ttkdl-cli/src/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@thiagobrg60/ttkdl-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

TTKDL-CLI

Repository size Npm version Npm downloads

📝 Description

TTKDL-CLI is a lightweight command-line tool for downloading TikTok videos directly from one or multiple URLs. It lets you configure download paths, control concurrent download limits, and set persistent default folders for saving videos across sessions.

🚀 Features

Download one or multiple TikTok videos from URLs (any URL format, full or short).
Concurrent downloads (up to 5 videos at a time).
Custom output paths or persistent default save folders.
Simple and intuitive command-line interface.

💻 Technologies

Node.js (runtime for the CLI)
JavaScript (ES Modules)

⚙️ Prerequisites

Before using the CLI, make sure you have installed:

Node.js (version 18.x or higher)
npm (Node.js package manager)

To check if you have Node.js and npm installed, run:

node -v
npm -v

If you don't have Node.js installed, you can download it here: https://nodejs.org.

🛠️ Installation

You can run the CLI either by installing it globally or using npx:

Global Installation

npm install -g @thiagobrg60/ttkdl-cli

After installing, the ttkdl command will be available globally in your terminal.

Using npx (without installing)

npx @thiagobrg60/ttkdl-cli "https://www.tiktok.com/@example/video/123456789"

📖 Usage

Single Download

Download a single TikTok video:

# Single download with full URL
ttkdl "https://www.tiktok.com/@example/video/123456789"

# Single download with short URL
ttkdl "https://vm.tiktok.com/example"

Multiple Downloads

Download multiple videos at once:

# Multiple downloads with mixed URLs
ttkdl "https://www.tiktok.com/@example/video/123456789" "https://vt.tiktok.com/example-2" "https://vm.tiktok.com/example-3"

Custom Output Path

Specify a custom save location for a single download session:

ttkdl "https://vt.tiktok.com/example" -o "./my/folder"

Maximum Concurrent Downloads

Set the number of videos to download simultaneously (max: 5):

ttkdl "https://vm.tiktok.com/example-1" "https://vt.tiktok.com/example-2" -m 5

Default Save Location

Configure a persistent default folder for all downloads:

ttkdl config -r "C:/default/videos/folder"

🎯 Command Reference

Global Commands

ttkdl [options]

Arguments / Options	Description
`-h, --help`	Shows the help message
`-v, --version`	Shows the current CLI version

Download Commands

ttkdl <urls> [options]

Arguments / Options	Description	Default
`<urls>`	One or more valid TikTok URLs (e.g., https://vt.tiktok.com/example)	—
`-o, --output <path>`	Sets the save path for videos (one-time, optional)	Windows: `C:/Users/<username>` Linux: `/home/<username>` macOS: `/Users/<username>`
`-m, --max <number>`	Sets the number of videos to download simultaneously (max 5, optional)	3

Configuration Commands

ttkdl config [options]

Arguments / Options	Description	Default
`-r, --root <path>`	Sets the default folder where videos will be saved (persistent)	Windows: `C:/Users/<username>` Linux: `/home/<username>` macOS: `/Users/<username>`

🤝 Contributing

Contributions are welcome! To contribute to the project, follow these steps:

Fork the repository.
Create a branch for your feature or change: git checkout -b your-branch-name.
Make your changes, add and commit: git add . and git commit -m 'commit message'.
Push your changes to the forked repository: git push origin your-branch-name.
Create a pull request on GitHub to the main repository.

💡 If you find a bug or have a feature request, please open an Issue on GitHub.

📬 Contact

If you have any questions, feel free to contact me via email:

📄 License

This project is licensed under the MIT License. See the LICENSE file for more details.

⭐ If this project helped you, consider leaving a star on the repository!