X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Ftools%2FREADME.md;h=d7ecd400425457b312cd54a79ec32484e41ecdea;hb=7815dc450ea9f8fd63e2234b6215013a132e6229;hp=6b94d74e503514a5e6efadaf0c5186311e919d96;hpb=7cf3e57376422e890e9703b68107e6f568a11384;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/tools/README.md b/server/tools/README.md index 6b94d74e5..d7ecd4004 100644 --- a/server/tools/README.md +++ b/server/tools/README.md @@ -1,82 +1,3 @@ -peertube(8) -- companion CLI for PeerTube -========================================= +# PeerTube CLI -SYNOPSIS --------- - -``` -peertube [command] [options] -``` - -DESCRIPTION ------------ - -`peertube` wraps various utilities around PeerTube that are used either on a running local, running remote, or cold local instance. - -COMMANDS --------- - -Unless otherwise specified, every command can be queried for its own help or manual by passing its name to the `help` command, or by using the `--help` option. - -`auth [action]`: stores credentials for your accounts on remote instances so that you don't need to pass them at every command - -`upload|up`: upload a video to a remote instance - - $ peertube upload \ - -u "PEERTUBE_URL" \ - -U "PEERTUBE_USER" \ - --password "PEERTUBE_PASSWORD" - -`import-videos|import`: import a video from a streaming platform to a remote instance - - $ peertube import \ - -u "PEERTUBE_URL" \ - -U "PEERTUBE_USER" \ - --password "PEERTUBE_PASSWORD" \ - -t "TARGET_URL" - - The target URL can be directly the video file, or any of the supported sites of youtube-dl. The video is downloaded locally and then uploaded. Already downloaded videos will not be uploaded twice, so you can run and re-run the script in case of crash, disconnection… - -`watch|w`: watch a video in the terminal ✩°。⋆ - - -g, --gui player type (default: ascii) - -i, --invert invert colors (ascii player only) - -r, --resolution video resolution (default: 720) - - It provides support for different players: - - - ascii (default ; plays in ascii art in your terminal!) - - mpv - - mplayer - - vlc - - stdout - - xbmc - - airplay - - chromecast - -`repl`: interact with the application libraries and objects even when PeerTube is not running - - Type .help to see the repl-only functions, or to see the available PeerTube core functions: - - repl> lodash.keys(context) - -`help [cmd]`: display help for [cmd] - -EXAMPLES --------- - - $ peertube auth add -u "PEERTUBE_URL" -U "PEERTUBE_USER" --password "PEERTUBE_PASSWORD" - $ peertube up - $ peertube watch https://peertube.cpy.re/videos/watch/e8a1af4e-414a-4d58-bfe6-2146eed06d10 - -SEE ALSO --------- - -[PeerTube Tools Documentation](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/tools.md) - -[PeerTube Admin Documentation](https://docs.joinpeertube.org/lang/en/docs/) - -REPORTING BUGS --------------- - -See [PeerTube repository](https://github.com/Chocobozzz/PeerTube). +See https://docs.joinpeertube.org/maintain/tools#remote-tools