aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc
diff options
context:
space:
mode:
Diffstat (limited to 'support/doc')
-rw-r--r--support/doc/tools.md58
1 files changed, 24 insertions, 34 deletions
diff --git a/support/doc/tools.md b/support/doc/tools.md
index 7f93c94f2..eb3f97eb4 100644
--- a/support/doc/tools.md
+++ b/support/doc/tools.md
@@ -1,42 +1,31 @@
1# CLI tools guide
2
1<!-- START doctoc generated TOC please keep comment here to allow auto update --> 3<!-- START doctoc generated TOC please keep comment here to allow auto update -->
2<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> 4<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
3**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* 5**Table of Contents**
4 6
5- [CLI tools guide](#cli-tools-guide) 7- [CLI wrapper](#cli-wrapper)
6 - [CLI wrapper](#cli-wrapper) 8- [Remote Tools](#remote-tools)
7 - [Remote Tools](#remote-tools) 9 - [Dependencies](#dependencies)
8 - [Dependencies](#dependencies) 10 - [Installation](#installation)
9 - [Installation](#installation) 11 - [peertube-import-videos.js](#peertube-import-videosjs)
10 - [peertube-import-videos.js](#peertube-import-videosjs) 12 - [peertube-upload.js](#peertube-uploadjs)
11 - [peertube-upload.js](#peertube-uploadjs) 13 - [peertube-watch.js](#peertube-watchjs)
12 - [peertube-watch.js](#peertube-watchjs) 14- [Server tools](#server-tools)
13 - [Server tools](#server-tools) 15 - [parse-log](#parse-log)
14 - [parse-log](#parse-log) 16 - [create-transcoding-job.js](#create-transcoding-jobjs)
15 - [create-transcoding-job.js](#create-transcoding-jobjs) 17 - [create-import-video-file-job.js](#create-import-video-file-jobjs)
16 - [create-import-video-file-job.js](#create-import-video-file-jobjs) 18 - [prune-storage.js](#prune-storagejs)
17 - [prune-storage.js](#prune-storagejs) 19 - [optimize-old-videos.js](#optimize-old-videosjs)
18 - [optimize-old-videos.js](#optimize-old-videosjs) 20 - [update-host.js](#update-hostjs)
19 - [update-host.js](#update-hostjs) 21 - [REPL (Read Eval Print Loop)](#repl-read-eval-print-loop)
20 - [REPL (Read Eval Print Loop)](#repl-read-eval-print-loop) 22 - [.help](#help)
21 - [.help](#help) 23 - [Lodash example](#lodash-example)
22 - [Lodash example](#lodash-example) 24 - [YoutubeDL example](#youtubedl-example)
23 - [YoutubeDL example](#youtubedl-example) 25 - [Models examples](#models-examples)
24 - [Models examples](#models-examples)
25 26
26<!-- END doctoc generated TOC please keep comment here to allow auto update --> 27<!-- END doctoc generated TOC please keep comment here to allow auto update -->
27 28
28# CLI tools guide
29 - [CLI wrapper](#cli-wrapper)
30 - [Remote tools](#remote-tools)
31 - [peertube-import-videos.js](#peertube-import-videosjs)
32 - [peertube-upload.js](#peertube-uploadjs)
33 - [peertube-watch.js](#peertube-watch)
34 - [Server tools](#server-tools)
35 - [parse-log](#parse-log)
36 - [create-transcoding-job.js](#create-transcoding-jobjs)
37 - [create-import-video-file-job.js](#create-import-video-file-jobjs)
38 - [prune-storage.js](#prune-storagejs)
39
40## CLI wrapper 29## CLI wrapper
41 30
42The wrapper provides a convenient interface to most scripts, and requires the [same dependencies](#dependencies). You can access it as `peertube` via an alias in your `.bashrc` like `alias peertube="node ${PEERTUBE_PATH}/dist/server/tools/peertube.js"`: 31The wrapper provides a convenient interface to most scripts, and requires the [same dependencies](#dependencies). You can access it as `peertube` via an alias in your `.bashrc` like `alias peertube="node ${PEERTUBE_PATH}/dist/server/tools/peertube.js"`:
@@ -55,6 +44,7 @@ The wrapper provides a convenient interface to most scripts, and requires the [s
55 upload|up upload a video 44 upload|up upload a video
56 import-videos|import import a video from a streaming platform 45 import-videos|import import a video from a streaming platform
57 watch|w watch a video in the terminal ✩°。⋆ 46 watch|w watch a video in the terminal ✩°。⋆
47 repl initiate a REPL to access internals
58 help [cmd] display help for [cmd] 48 help [cmd] display help for [cmd]
59``` 49```
60 50