npm-restart.1 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102
  1. .TH "NPM\-RESTART" "1" "October 2021" "" ""
  2. .SH "NAME"
  3. \fBnpm-restart\fR \- Restart a package
  4. .SS Synopsis
  5. .P
  6. .RS 2
  7. .nf
  8. npm restart [\-\- <args>]
  9. .fi
  10. .RE
  11. .SS Description
  12. .P
  13. This restarts a project\. It is equivalent to running \fBnpm run\-script
  14. restart\fP\|\.
  15. .P
  16. If the current project has a \fB"restart"\fP script specified in
  17. \fBpackage\.json\fP, then the following scripts will be run:
  18. .RS 0
  19. .IP 1. 3
  20. prerestart
  21. .IP 2. 3
  22. restart
  23. .IP 3. 3
  24. postrestart
  25. .RE
  26. .P
  27. If it does \fInot\fR have a \fB"restart"\fP script specified, but it does have
  28. \fBstop\fP and/or \fBstart\fP scripts, then the following scripts will be run:
  29. .RS 0
  30. .IP 1. 3
  31. prerestart
  32. .IP 2. 3
  33. prestop
  34. .IP 3. 3
  35. stop
  36. .IP 4. 3
  37. poststop
  38. .IP 5. 3
  39. prestart
  40. .IP 6. 3
  41. start
  42. .IP 7. 3
  43. poststart
  44. .IP 8. 3
  45. postrestart
  46. .RE
  47. .SS Configuration
  48. <!\-\- AUTOGENERATED CONFIG DESCRIPTIONS START \-\->
  49. <!\-\- automatically generated, do not edit manually \-\->
  50. <!\-\- see lib/utils/config/definitions\.js \-\->
  51. .SS \fBignore\-scripts\fP
  52. .RS 0
  53. .IP \(bu 2
  54. Default: false
  55. .IP \(bu 2
  56. Type: Boolean
  57. .RE
  58. .P
  59. If true, npm does not run scripts specified in package\.json files\.
  60. .P
  61. Note that commands explicitly intended to run a particular script, such as
  62. \fBnpm start\fP, \fBnpm stop\fP, \fBnpm restart\fP, \fBnpm test\fP, and \fBnpm run\-script\fP
  63. will still run their intended script if \fBignore\-scripts\fP is set, but they
  64. will \fInot\fR run any pre\- or post\-scripts\.
  65. <!\-\- automatically generated, do not edit manually \-\->
  66. <!\-\- see lib/utils/config/definitions\.js \-\->
  67. .SS \fBscript\-shell\fP
  68. .RS 0
  69. .IP \(bu 2
  70. Default: '/bin/sh' on POSIX systems, 'cmd\.exe' on Windows
  71. .IP \(bu 2
  72. Type: null or String
  73. .RE
  74. .P
  75. The shell to use for scripts run with the \fBnpm exec\fP, \fBnpm run\fP and \fBnpm
  76. init <pkg>\fP commands\.
  77. <!\-\- automatically generated, do not edit manually \-\->
  78. <!\-\- see lib/utils/config/definitions\.js \-\->
  79. <!\-\- AUTOGENERATED CONFIG DESCRIPTIONS END \-\->
  80. .SS See Also
  81. .RS 0
  82. .IP \(bu 2
  83. npm help run\-script
  84. .IP \(bu 2
  85. npm help scripts
  86. .IP \(bu 2
  87. npm help test
  88. .IP \(bu 2
  89. npm help start
  90. .IP \(bu 2
  91. npm help stop
  92. .IP \(bu 2
  93. npm help restart
  94. .RE