projects / github / Chocobozzz / PeerTube.git / blame
| Commit | Line | Data |
|---|---|---|
| 7cf3e573 RK |
1 | peertube(8) -- companion CLI for PeerTube |
| 2 | ========================================= | |
| 3 | ||
| 4 | SYNOPSIS | |
| 5 | -------- | |
| 6 | ||
| 7 | ``` | |
| 8 | peertube [command] [options] | |
| 9 | ``` | |
| 10 | ||
| 11 | DESCRIPTION | |
| 12 | ----------- | |
| 13 | ||
| 14 | `peertube` wraps various utilities around PeerTube that are used either on a running local, running remote, or cold local instance. | |
| 15 | ||
| 16 | COMMANDS | |
| 17 | -------- | |
| 18 | ||
| 19 | 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. | |
| 20 | ||
| 32d7f2b7 | 21 | `auth [action]`: stores credentials for your accounts on remote instances, so that you don't need to pass them at every command |
| 7cf3e573 RK |
22 | |
| 23 | `upload|up`: upload a video to a remote instance | |
| 24 | ||
| 25 | $ peertube upload \ | |
| 26 | -u "PEERTUBE_URL" \ | |
| 27 | -U "PEERTUBE_USER" \ | |
| 28 | --password "PEERTUBE_PASSWORD" | |
| 29 | ||
| 30 | `import-videos|import`: import a video from a streaming platform to a remote instance | |
| 31 | ||
| 32 | $ peertube import \ | |
| 33 | -u "PEERTUBE_URL" \ | |
| 34 | -U "PEERTUBE_USER" \ | |
| 35 | --password "PEERTUBE_PASSWORD" \ | |
| 36 | -t "TARGET_URL" | |
| 37 | ||
| 38 | 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… | |
| 39 | ||
| 40 | `watch|w`: watch a video in the terminal ✩°｡⋆ | |
| 41 | ||
| 42 | -g, --gui <player> player type (default: ascii) | |
| 43 | -i, --invert invert colors (ascii player only) | |
| 44 | -r, --resolution <res> video resolution (default: 720) | |
| 45 | ||
| 46 | It provides support for different players: | |
| 47 | ||
| 48 | - ascii (default ; plays in ascii art in your terminal!) | |
| 49 | - mpv | |
| 50 | - mplayer | |
| 51 | - vlc | |
| 52 | - stdout | |
| 53 | - xbmc | |
| 54 | - airplay | |
| 55 | - chromecast | |
| 56 | ||
| 57 | `repl`: interact with the application libraries and objects even when PeerTube is not running | |
| 58 | ||
| 59 | Type .help to see the repl-only functions, or to see the available PeerTube core functions: | |
| 60 | ||
| 61 | repl> lodash.keys(context) | |
| 62 | ||
| 63 | `help [cmd]`: display help for [cmd] | |
| 64 | ||
| 65 | EXAMPLES | |
| 66 | -------- | |
| 67 | ||
| 68 | $ peertube auth add -u "PEERTUBE_URL" -U "PEERTUBE_USER" --password "PEERTUBE_PASSWORD" | |
| 69 | $ peertube up <videoFile> | |
| 70 | $ peertube watch https://peertube.cpy.re/videos/watch/e8a1af4e-414a-4d58-bfe6-2146eed06d10 | |
| 71 | ||
| 72 | SEE ALSO | |
| 73 | -------- | |
| 74 | ||
| 75 | [PeerTube Tools Documentation](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/tools.md) | |
| 76 | ||
| 77 | [PeerTube Admin Documentation](https://docs.joinpeertube.org/lang/en/docs/) | |
| 78 | ||
| 79 | REPORTING BUGS | |
| 80 | -------------- | |
| 81 | ||
| 82 | See [PeerTube repository](https://github.com/Chocobozzz/PeerTube). |