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

#!/usr/bin/env sh

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:prod           -> Build the server for production\n"
printf "  build:client:prod           -> Build the client for production\n"
printf "  clean                       -> Clean the application\n"
printf "  clean:client                -> Clean the client build files (dist directory)\n"
printf "  clean:server:test           -> Clean certificates, logs, uploads and database of the test instances\n"
printf "  watch:client                -> Watch 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 "  dev                         -> Watch, run the livereload and run the server so that you can develop the application\n"
printf "  start                       -> Run the server\n"
printf "  check                       -> Check the server (according to NODE_ENV)\n"
printf "  upgrade -- [branch]         -> Upgrade the application according to the [branch] parameter\n"
printf "  update-host                 -> Upgrade scheme/host in torrent files according to the webserver configuration (config/ folder)\n"
printf "  test                        -> Run the tests\n"
printf "  help                        -> Print this help\n"
Commit	Line	Data
93534495 C	1	#!/usr/bin/env sh
	2
	3	printf "############# PeerTube help #############\n\n"
	4	printf "npm run ...\n"
9a5d2a3f	5	printf " build -> Build the application for production (alias of build:client:prod)\n"
75fb0c0b	6	printf " build:server:prod -> Build the server for production\n"
9a5d2a3f C	7	printf " build:client:prod -> Build the client for production\n"
	8	printf " clean -> Clean the application\n"
	9	printf " clean:client -> Clean the client build files (dist directory)\n"
	10	printf " clean:server:test -> Clean certificates, logs, uploads and database of the test instances\n"
	11	printf " watch:client -> Watch the client files\n"
	12	printf " danger:clean:dev -> /!\ Clean certificates, logs, uploads, thumbnails, torrents and database specified in the development environment\n"
	13	printf " danger:clean:prod -> /!\ Clean certificates, logs, uploads, thumbnails, torrents and database specified by the production environment\n"
	14	printf " danger:clean:modules -> /!\ Clean node and typescript modules\n"
	15	printf " play -> Run 3 fresh nodes so that you can test the communication between them\n"
01a07456	16	printf " reset-password -- -u [user] -> Reset the password of user [user]\n"
9a5d2a3f C	17	printf " dev -> Watch, run the livereload and run the server so that you can develop the application\n"
	18	printf " start -> Run the server\n"
	19	printf " check -> Check the server (according to NODE_ENV)\n"
	20	printf " upgrade -- [branch] -> Upgrade the application according to the [branch] parameter\n"
01a07456	21	printf " update-host -> Upgrade scheme/host in torrent files according to the webserver configuration (config/ folder)\n"
9a5d2a3f C	22	printf " test -> Run the tests\n"
9a5d2a3f C	23	printf " help -> Print this help\n"