[github/Chocobozzz/PeerTube.git] / scripts / help.sh

#!/bin/sh

set -eu

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