scripts/help.sh

   1 #!/bin/sh
   2
   3 set -eu
   4
   5 printf "############# PeerTube help #############\n\n"
   6 printf "npm run ...\n"
   7 printf "  build                       -> Build the application for production (alias of build:client:prod)\n"
   8 printf "  build:server                -> Build the server for production\n"
   9 printf "  build:client                -> Build the client for production\n"
  10 printf "  clean:client                -> Clean the client build files (dist directory)\n"
  11 printf "  clean:server:test           -> Clean logs, uploads, database... of the test instances\n"
  12 printf "  watch:client                -> Watch and compile on the fly the client files\n"
  13 printf "  danger:clean:dev            -> /!\ Clean certificates, logs, uploads, thumbnails, torrents and database specified in the development environment\n"
  14 printf "  danger:clean:prod           -> /!\ Clean certificates, logs, uploads, thumbnails, torrents and database specified by the production environment\n"
  15 printf "  danger:clean:modules        -> /!\ Clean node and typescript modules\n"
  16 printf "  play                        -> Run 3 fresh nodes so that you can test the communication between them\n"
  17 printf "  reset-password -- -u [user] -> Reset the password of user [user]\n"
  18 printf "  create-transcoding-job -- -v [video UUID] \n"
  19 printf "                              -> Create a transcoding job for a particular video\n"
  20 printf "  prune-storage               -> Delete (after confirmation) unknown video files/thumbnails/previews... (due to a bad video deletion, transcoding job not finished...)\n"
  21 printf "  optimize-old-videos         -> Re-transcode videos that have a high bitrate, to make them suitable for streaming over slow connections"
  22 printf "  dev                         -> Watch, run the livereload and run the server so that you can develop the application\n"
  23 printf "  start                       -> Run the server\n"
  24 printf "  update-host                 -> Upgrade scheme/host in torrent files according to the webserver configuration (config/ folder)\n"
  25 printf "  client-report               -> Open a report of the client dependencies module\n"
  26 printf "  test                        -> Run the tests\n"
  27 printf "  help                        -> Print this help\n"