https://github.com/superchupudev/tusc
The ultimate social content video downloader
https://github.com/superchupudev/tusc
Last synced: 3 months ago
JSON representation
The ultimate social content video downloader
- Host: GitHub
- URL: https://github.com/superchupudev/tusc
- Owner: SuperchupuDev
- License: apache-2.0
- Created: 2023-01-10T16:42:51.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-04T11:42:25.000Z (over 3 years ago)
- Last Synced: 2026-04-06T16:07:40.180Z (4 months ago)
- Language: TypeScript
- Size: 250 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tusc
If you want something more stable and easy to use, check out [tusc-gui][tusc-gui]
A wrapper around [yt-dlp][yt-dlp] that makes it easier to use for non-technical users
It's on an early stage with a lot of changes expected to happen, if you want something stable, you should probably use its JavaScript API, [tusc-gui][tusc-gui], or [yt-dlp][yt-dlp] directly
## Installation
```sh-session
npm i -g @superchupu/tusc
```
## Usage
```bash
tusc [options]
```
### Options
`-e` - Makes explorer not open on finish
`--update` - Updates tusc's yt-dlp installation
## API
```ts
import { run } from '@superchupu/tusc';
await run({
url: 'https://youtu.be/7cXgViHb4NM',
resolution: 1080,
extension: 'mp4',
openExplorer: false
});
```
### Options
```ts
export interface TuscOptions {
extension?: Extension;
onData?: (data: string) => unknown;
onErrorData?: (data: string) => unknown;
openExplorer: boolean;
path: string;
resolution?: number | 'best';
url: string | null;
ytDlpPath?: string;
}
```
[tusc-gui]: https://github.com/SuperchupuDev/tusc-gui
[yt-dlp]: https://github.com/yt-dlp/yt-dlp