gulp.1 3.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. .TH "GULP" "" "June 2020" "" ""
  2. .SH "NAME"
  3. \fBgulp\fR
  4. .SS Usage
  5. .P
  6. \fBgulp [flags] <task> <task>\.\.\.\fP
  7. .SS Tasks
  8. .P
  9. The task(s) listed will be executed\.
  10. If more than one task is listed, Gulp will execute all of them
  11. concurrently, that is, as if they had all been listed as dependencies of
  12. a single task\.
  13. .P
  14. By default, Gulp does not serialize tasks listed on the command line\. If you would like to execute tasks serially, you must specify the \fB\-\-series\fP flag\. e\.g\. \fBgulp clean build \-\-series\fP
  15. .P
  16. Just running \fBgulp\fP will execute the task \fBdefault\fP\|\. If there is no
  17. \fBdefault\fP task, gulp will error\.
  18. .SS Compilers
  19. .P
  20. You can find a list of supported languages at https:// If you would like to add support for a new language, send pull requests/open issues on that project\.
  21. .SS Environment
  22. .P
  23. The CLI adds process\.env\.INIT_CWD which is the original cwd it was launched from\.
  24. .SS Flags
  25. .P
  26. gulp has very few flags to know about\. All other flags are for tasks to use if needed\.
  27. .P
  28. \fBSome flags only work with gulp 4 and will be ignored when invoked against gulp 3\.\fR
  29. .P
  30. \fB\-\-help\fR, \fB\-h\fR
  31. Show the help\.
  32. .P
  33. \fB\-\-version\fR, \fB\-v\fR
  34. Print the global and local gulp versions\.
  35. .P
  36. \fB\-\-require\fR [path]
  37. Will require a module before running the gulpfile\. This is useful for transpilers but also has other applications\.
  38. .P
  39. \fB\-\-gulpfile\fR [path], \fB\-f\fR [path]
  40. Manually set path of gulpfile\. Useful if you have multiple gulpfiles\. This will set the CWD to the gulpfile directory as well\.
  41. .P
  42. \fB\-\-cwd\fR [path]
  43. Manually set the CWD\. The search for the gulpfile, as well as the relativity of all requires will be from here\.
  44. .P
  45. \fB\-\-verify\fR [path (optional)]
  46. Will verify plugins referenced in project's package\.json against the plugins blacklist\.
  47. .P
  48. \fB\-\-tasks\fR, \fB\-T\fR
  49. Print the task dependency tree for the loaded gulpfile\.
  50. .P
  51. \fB\-\-tasks\-simple\fR
  52. Print a plaintext list of tasks for the loaded gulpfile\.
  53. .P
  54. \fB\-\-tasks\-json\fR [path]
  55. Print the task dependency tree, in JSON format, for the loaded gulpfile\. The [path] argument is optional, and if given writes the JSON to the path\.
  56. .P
  57. \fB\-\-tasks\-depth\fR [number]
  58. Specify the depth of the task dependency tree to print\. This flag can be used with \-\-tasks or \-\-tasks\-json\. (This flag was named \-\-depth before but is deprecated\.)
  59. .P
  60. \fB\-\-compact\-tasks\fR
  61. Reduce the output of task dependency tree by printing only top tasks and their child tasks\. This flag can be used with \-\-tasks or \-\-tasks\-json\.
  62. .P
  63. \fB\-\-sort\-tasks\fR
  64. Will sort top tasks of task dependency tree\. This flag can be used with \-\-tasks\.
  65. .P
  66. \fB\-\-color\fR
  67. Will force gulp and gulp plugins to display colors, even when no color support is detected\.
  68. .P
  69. \fB\-\-no\-color\fR
  70. Will force gulp and gulp plugins to not display colors, even when color support is detected\.
  71. .P
  72. \fB\-\-silent\fR, \fB\-S\fR
  73. Suppress all gulp logging\.
  74. .P
  75. \fB\-\-continue\fR
  76. Continue execution of tasks upon failure\.
  77. .P
  78. \fB\-\-series\fR
  79. Run tasks given on the CLI in series (the default is parallel)\.
  80. .P
  81. \fB\-\-log\-level\fR, \fB\-L\fR
  82. Set the loglevel\. \-L for least verbose and \-LLLL for most verbose\. \-LLL is default\.