History

BRAINS YUM fa27f07637 allow peertube-import-videos.ts CLI script to run concurrently (#1334 ) allows running multiple imports at the same time, whereas previously a concurrent instance of the script deleted another processe's file.		2018-10-24 20:07:51 +02:00
..
README.md	(doc) add manpage to peertube cli	2018-10-20 19:16:56 +02:00
cli.ts	Fix #1328 - application-config initialisation in CLI tools (#1343 )	2018-10-24 12:28:25 +02:00
peertube-auth.ts	one cli to unite them all	2018-09-14 11:08:55 +02:00
peertube-get-access-token.ts	one cli to unite them all	2018-09-14 11:08:55 +02:00
peertube-import-videos.ts	allow peertube-import-videos.ts CLI script to run concurrently (#1334 )	2018-10-24 20:07:51 +02:00
peertube-repl.ts	add repl to the cli wrapper, remove extraneous TOC in tools.md	2018-10-19 14:24:35 +02:00
peertube-upload.ts	Define channelId property beforehand	2018-10-01 14:14:49 +02:00
peertube-watch.ts	one cli to unite them all	2018-09-14 11:08:55 +02:00
peertube.ts	add repl to the cli wrapper, remove extraneous TOC in tools.md	2018-10-19 14:24:35 +02:00

README.md

peertube(8) -- companion CLI for PeerTube

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>      player type (default: ascii)
-i, --invert            invert colors (ascii player only)
-r, --resolution <res>  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 <videoFile>
$ peertube watch https://peertube.cpy.re/videos/watch/e8a1af4e-414a-4d58-bfe6-2146eed06d10

REPORTING BUGS

See PeerTube repository.