Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: move to yargs, use chalk #144

Merged
merged 52 commits into from
Jul 9, 2021
Merged
Show file tree
Hide file tree
Changes from 51 commits
Commits
Show all changes
52 commits
Select commit Hold shift + click to select a range
9df8620
Create new branch: revamp
Sep 12, 2020
b4625a5
Complete revamp
Sep 13, 2020
0263c0b
Added quote function
Sep 13, 2020
1c16007
Bugfixes
Sep 13, 2020
586be3e
Bugfixes
OsmanAltun Sep 13, 2020
d7f6832
Replace console.log with process.stdout.write
OsmanAltun Sep 13, 2020
6c06da5
Bugfixes
OsmanAltun Sep 13, 2020
14e17b4
Cleanup dependencies
OsmanAltun Sep 13, 2020
2bf7db5
Added feature
OsmanAltun Sep 14, 2020
883ac9a
Standard --fix
OsmanAltun Sep 14, 2020
c3482a5
Update docs
OsmanAltun Sep 14, 2020
fa79bec
Standard --fix
OsmanAltun Sep 14, 2020
c12a70d
Fix small bug
OsmanAltun Sep 14, 2020
580b710
Standard --fix
OsmanAltun Sep 14, 2020
32c6282
Multiple torrent downloads fix
OsmanAltun Sep 14, 2020
e97c107
Less hard coding
OsmanAltun Sep 14, 2020
190fb07
Small adjustments
Sep 15, 2020
a92f5ef
Fix optiongroup order
Sep 15, 2020
94c561c
Pull updates
OsmanAltun Nov 14, 2020
d53e125
Replace yargs with minimist wrapper
OsmanAltun Nov 21, 2020
1b2bc57
Pull from origin/master
OsmanAltun Nov 21, 2020
acb9cd2
Revert commit: 94c561c
OsmanAltun Nov 22, 2020
84b2de2
Pull changes 3.2.1
OsmanAltun Nov 22, 2020
1e7b872
Pull changes 3.2.1
OsmanAltun Nov 22, 2020
5f38dc1
resolve conflict
OsmanAltun Nov 22, 2020
808fe85
Fix busy port issue
OsmanAltun Nov 22, 2020
3395895
Small fixes
OsmanAltun Nov 22, 2020
71f5f6e
Small changes
OsmanAltun Nov 22, 2020
9b3d5b7
Small fixes
OsmanAltun Nov 22, 2020
50696ee
Small fixes
OsmanAltun Nov 23, 2020
27c6e7b
Small changes
OsmanAltun Nov 23, 2020
122bf51
Remove unnecessary complexity
OsmanAltun Nov 23, 2020
752c7f8
Webtorrent 0.112.0
OsmanAltun Dec 2, 2020
cd56722
Small fixes
OsmanAltun Dec 3, 2020
23b8f56
Small fix
OsmanAltun Dec 3, 2020
97a8c0f
Remove clivas.flush
OsmanAltun Dec 5, 2020
dd364ff
Revert removal
OsmanAltun Dec 5, 2020
8e3bc27
Replace Clivas with Chalk and console.log
OsmanAltun Dec 5, 2020
d869956
Yargs 16.2.0
OsmanAltun Dec 6, 2020
c69c854
Small fix
OsmanAltun Dec 6, 2020
096b6fe
Small improvements
OsmanAltun Dec 6, 2020
280073d
Merge 'upstream/master'
OsmanAltun May 31, 2021
7b016e0
dependency fix
OsmanAltun May 31, 2021
3a5084b
Merge branch 'master' of https://github.com/webtorrent/webtorrent-cli
OsmanAltun Jun 3, 2021
683c0d0
Yargs 17.0.1
OsmanAltun Jun 3, 2021
326333d
Update .gitignore
OsmanAltun Jun 3, 2021
50fb77f
Update .gitignore
OsmanAltun Jun 4, 2021
95cdd49
Add [default] to download description
OsmanAltun Jun 5, 2021
52fcf2b
Remove regions
OsmanAltun Jun 5, 2021
f7e7ef2
Merge branch 'master' of https://github.com/webtorrent/webtorrent-cli
OsmanAltun Jun 5, 2021
ec27223
Update .gitignore
DiegoRBaquero Jun 6, 2021
7c4d163
Merge branch 'master' of https://github.com/webtorrent/webtorrent-cli
OsmanAltun Jun 8, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 46 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,54 +65,65 @@ $ webtorrent --help
\_/\_/ \___|_.__/ \__\___/|_| |_| \___|_| |_|\__|

Usage:
webtorrent [command] <torrent-id> <options>
webtorrent [command] <torrent-id> [options]

Example:
Examples:
webtorrent download "magnet:..." --vlc
webtorrent "magnet:..." --vlc --player-args="--video-on-top --repeat"
OsmanAltun marked this conversation as resolved.
Show resolved Hide resolved

Commands:
download <torrent-id...> Download a torrent
downloadmeta <torrent-id...> Download torrent metafile and save it usually from magnet link
seed <file/folder...> Seed a file or folder
create <file/folder> Create a .torrent file
info <torrent-id> Show info for a .torrent file or magnet uri
Default output location:
* when streaming: Temp folder
* when downloading: Current directory

Specify <torrent-id> as one of:
* magnet uri
* http url to .torrent file
* filesystem path to .torrent file
* info hash (hex string)

Commands:
webtorrent download [torrent-ids...] Download a torrent [default]
webtorrent downloadmeta <torrent-ids...> Download metadata of torrent
webtorrent seed <inputs...> Seed a file or a folder
webtorrent create <input> Create a .torrent file
webtorrent info <torrent-id> Show torrent information
webtorrent version Show version information
webtorrent help Show help information

Options (streaming):
--airplay Apple TV
--chromecast Chromecast
--dlna DLNA
--mplayer MPlayer
--mpv MPV
--omx [jack] omx [default: hdmi]
--vlc VLC
--iina IINA
--xbmc XBMC
--stdout standard out (implies --quiet)
--airplay Apple TV
--chromecast Google Chromecast [default: all]
--dlna DNLA
--mplayer MPlayer
--mpv MPV
--omx OMX [default: hdmi]
--vlc VLC
--iina IINA
--xbmc XBMC
--stdout Standard out (implies --quiet)

Options (simple):
-o, --out [path] set download destination [default: current directory]
-s, --select [index] select specific file in torrent (omit index for file list)
-t, --subtitles [path] load subtitles file
-v, --version print the current version

Options (advanced):
-p, --port [number] change the http server port [default: 8000]
-b, --blocklist [path] load blocklist file/http url
-a, --announce [url] tracker URL to announce to
-q, --quiet don't show UI on stdout
--pip enter Picture-in-Picture if supported by the player
--not-on-top don't set "always on top" option in player
--keep-seeding don't quit when done downloading
--no-quit don't quit when player exits
--on-done [script] run script after torrent download is done
--on-exit [script] run script before program exit
--verbose show torrent protocol details
-o, --out Set download destination [string]
-s, --select Select specific file in torrent
-t, --subtitles Load subtitles file [string]
-h, --help Show help information [boolean]
-v, --version Show version information [boolean]

Options (advanced)
-p, --port Change the http server port [default: 8000]
-b, --blocklist Load blocklist file/url [string]
-a, --announce Tracker URL to announce to [string]
-q, --quiet Don't show UI on stdout
--pip Enter Picture-in-Picture if supported by the player
--verbose Show torrent protocol details
--player-args Add player specific arguments (see example) [string]
--torrent-port Change the torrent seeding port [default: random]
--dht-port Change the dht port [default: random]
--not-on-top Don't set "always on top" option in player
--keep-seeding Don't quit when done downloading
--no-quit Don't quit when player exits
--on-done Run script after torrent download is done
--on-exit Run script before program exit
```

To download a torrent:
Expand Down
Loading