History

Chocobozzz 7942e72e38 Fix cli build		2021-08-06 14:39:28 +02:00
..
README.md	fix a few typos (#2141 )	2019-09-23 08:17:42 +02:00
cli.ts	Use an object to represent a server	2021-07-20 15:27:18 +02:00
package.json	Upgrade tools dependencies	2021-02-03 13:49:56 +01:00
peertube-auth.ts	Adapt CLI to new commands	2021-07-20 15:27:18 +02:00
peertube-get-access-token.ts	Adapt CLI to new commands	2021-07-20 15:27:18 +02:00
peertube-import-videos.ts	Use an object to represent a server	2021-07-20 15:27:18 +02:00
peertube-plugins.ts	Shorter server command names	2021-07-20 15:27:18 +02:00
peertube-redundancy.ts	Reorganize imports	2021-07-20 15:27:19 +02:00
peertube-repl.ts	Support short uuid for GET video/playlist	2021-06-29 14:56:35 +02:00
peertube-upload.ts	Shorter server command names	2021-07-20 15:27:18 +02:00
peertube-watch.ts	Update tools dependencies	2021-06-25 17:48:27 +02:00
peertube.ts	Update tools dependencies	2021-06-25 17:48:27 +02:00
test-live.ts	Fix cli build	2021-08-06 14:39:28 +02:00
tsconfig.json	Split types and typings	2020-06-18 10:46:27 +02:00
yarn.lock	Upgrade tools dep	2021-06-15 16:15:44 +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.