From c141f68be14193fb92d3f5cfc82cd1e156823c17 Mon Sep 17 00:00:00 2001 From: Rigel Kent Date: Fri, 19 Oct 2018 14:24:35 +0200 Subject: [PATCH] add repl to the cli wrapper, remove extraneous TOC in tools.md --- server/tools/{repl.ts => peertube-repl.ts} | 0 server/tools/peertube.ts | 1 + support/doc/tools.md | 58 +++++++++------------- 3 files changed, 25 insertions(+), 34 deletions(-) rename server/tools/{repl.ts => peertube-repl.ts} (100%) diff --git a/server/tools/repl.ts b/server/tools/peertube-repl.ts similarity index 100% rename from server/tools/repl.ts rename to server/tools/peertube-repl.ts diff --git a/server/tools/peertube.ts b/server/tools/peertube.ts index ad76bafb4..c8b9fa744 100755 --- a/server/tools/peertube.ts +++ b/server/tools/peertube.ts @@ -17,6 +17,7 @@ program .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('watch', 'watch a video in the terminal ✩°。⋆').alias('w') + .command('repl', 'initiate a REPL to access internals') /* Not Yet Implemented */ program 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 @@ +# CLI tools guide + -**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* - -- [CLI tools guide](#cli-tools-guide) - - [CLI wrapper](#cli-wrapper) - - [Remote Tools](#remote-tools) - - [Dependencies](#dependencies) - - [Installation](#installation) - - [peertube-import-videos.js](#peertube-import-videosjs) - - [peertube-upload.js](#peertube-uploadjs) - - [peertube-watch.js](#peertube-watchjs) - - [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) - - [optimize-old-videos.js](#optimize-old-videosjs) - - [update-host.js](#update-hostjs) - - [REPL (Read Eval Print Loop)](#repl-read-eval-print-loop) - - [.help](#help) - - [Lodash example](#lodash-example) - - [YoutubeDL example](#youtubedl-example) - - [Models examples](#models-examples) +**Table of Contents** + +- [CLI wrapper](#cli-wrapper) +- [Remote Tools](#remote-tools) + - [Dependencies](#dependencies) + - [Installation](#installation) + - [peertube-import-videos.js](#peertube-import-videosjs) + - [peertube-upload.js](#peertube-uploadjs) + - [peertube-watch.js](#peertube-watchjs) +- [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) + - [optimize-old-videos.js](#optimize-old-videosjs) + - [update-host.js](#update-hostjs) + - [REPL (Read Eval Print Loop)](#repl-read-eval-print-loop) + - [.help](#help) + - [Lodash example](#lodash-example) + - [YoutubeDL example](#youtubedl-example) + - [Models examples](#models-examples) -# 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 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 import-videos|import import a video from a streaming platform watch|w watch a video in the terminal ✩°。⋆ + repl initiate a REPL to access internals help [cmd] display help for [cmd] ``` -- 2.25.1