OpenCloud
/
PeerTube
mirror of https://github.com/Chocobozzz/PeerTube
1
0
Fork 0
Code Issues Releases Wiki Activity

add repl to the cli wrapper, remove extraneous TOC in tools.md

pull/1313/head
Rigel Kent 2018-10-19 14:24:35 +02:00
parent 6d8c8ea73a
commit c141f68be1
No known key found for this signature in database
GPG Key ID: EA12971B0E438F36
3 changed files with 24 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
server/tools/repl.ts → server/tools/peertube-repl.ts
View File

1
server/tools/peertube.ts
View File

@ -17,6 +17,7 @@ program
.command('import-videos', 'import a video from a streaming platform').alias('import') .command('import-videos', 'import a video from a streaming platform').alias('import')
.command('get-access-token', 'get a peertube access token', { noHelp: true }).alias('token') .command('get-access-token', 'get a peertube access token', { noHelp: true }).alias('token')
.command('watch', 'watch a video in the terminal ✩°｡⋆').alias('w') .command('watch', 'watch a video in the terminal ✩°｡⋆').alias('w')
.command('repl', 'initiate a REPL to access internals')
/* Not Yet Implemented */ /* Not Yet Implemented */
program program

56
support/doc/tools.md
View File

@ -1,42 +1,31 @@
# CLI tools guide
<!-- START doctoc generated TOC please keep comment here to allow auto update --> <!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* **Table of Contents**
- [CLI tools guide](#cli-tools-guide) - [CLI wrapper](#cli-wrapper)
- [CLI wrapper](#cli-wrapper) - [Remote Tools](#remote-tools)
- [Remote Tools](#remote-tools) - [Dependencies](#dependencies)
- [Dependencies](#dependencies) - [Installation](#installation)
- [Installation](#installation) - [peertube-import-videos.js](#peertube-import-videosjs)
- [peertube-import-videos.js](#peertube-import-videosjs) - [peertube-upload.js](#peertube-uploadjs)
- [peertube-upload.js](#peertube-uploadjs) - [peertube-watch.js](#peertube-watchjs)
- [peertube-watch.js](#peertube-watchjs) - [Server tools](#server-tools)
- [Server tools](#server-tools) - [parse-log](#parse-log)
- [parse-log](#parse-log) - [create-transcoding-job.js](#create-transcoding-jobjs)
- [create-transcoding-job.js](#create-transcoding-jobjs) - [create-import-video-file-job.js](#create-import-video-file-jobjs)
- [create-import-video-file-job.js](#create-import-video-file-jobjs) - [prune-storage.js](#prune-storagejs)
- [prune-storage.js](#prune-storagejs) - [optimize-old-videos.js](#optimize-old-videosjs)
- [optimize-old-videos.js](#optimize-old-videosjs) - [update-host.js](#update-hostjs)
- [update-host.js](#update-hostjs) - [REPL (Read Eval Print Loop)](#repl-read-eval-print-loop)
- [REPL (Read Eval Print Loop)](#repl-read-eval-print-loop) - [.help](#help)
- [.help](#help) - [Lodash example](#lodash-example)
- [Lodash example](#lodash-example) - [YoutubeDL example](#youtubedl-example)
- [YoutubeDL example](#youtubedl-example) - [Models examples](#models-examples)
- [Models examples](#models-examples)
<!-- END doctoc generated TOC please keep comment here to allow auto update --> <!-- END doctoc generated TOC please keep comment here to allow auto update -->
# CLI tools guide
- [CLI wrapper](#cli-wrapper)
- [Remote tools](#remote-tools)
- [peertube-import-videos.js](#peertube-import-videosjs)
- [peertube-upload.js](#peertube-uploadjs)
- [peertube-watch.js](#peertube-watch)
- [Server tools](#server-tools)
- [parse-log](#parse-log)
- [create-transcoding-job.js](#create-transcoding-jobjs)
- [create-import-video-file-job.js](#create-import-video-file-jobjs)
- [prune-storage.js](#prune-storagejs)
## CLI wrapper ## CLI wrapper
The 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"`: The 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
upload|up upload a video upload|up upload a video
import-videos|import import a video from a streaming platform import-videos|import import a video from a streaming platform
watch|w watch a video in the terminal ✩°｡⋆ watch|w watch a video in the terminal ✩°｡⋆
repl initiate a REPL to access internals
help [cmd] display help for [cmd] help [cmd] display help for [cmd]
``` ```