aboutsummaryrefslogtreecommitdiffhomepage
path: root/scripts/help.sh
blob: 51f55547e8f4976ae03a2f564753b00d81593fa4 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
#!/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"