gulp.1 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. .TH "GULP" "" "February 2016" "" ""
  2. .SH "NAME"
  3. \fBgulp\fR
  4. .SH gulp CLI docs
  5. .SS Flags
  6. .P
  7. gulp has very few flags to know about\. All other flags are for tasks to use if needed\.
  8. .RS 0
  9. .IP \(bu 2
  10. \fB\-v\fP or \fB\-\-version\fP will display the global and local gulp versions
  11. .IP \(bu 2
  12. \fB\-\-require <module path>\fP will require a module before running the gulpfile\. This is useful for transpilers but also has other applications\. You can use multiple \fB\-\-require\fP flags
  13. .IP \(bu 2
  14. \fB\-\-gulpfile <gulpfile path>\fP will manually set path of gulpfile\. Useful if you have multiple gulpfiles\. This will set the CWD to the gulpfile directory as well
  15. .IP \(bu 2
  16. \fB\-\-cwd <dir path>\fP will manually set the CWD\. The search for the gulpfile, as well as the relativity of all requires will be from here
  17. .IP \(bu 2
  18. \fB\-T\fP or \fB\-\-tasks\fP will display the task dependency tree for the loaded gulpfile
  19. .IP \(bu 2
  20. \fB\-\-tasks\-simple\fP will display a plaintext list of tasks for the loaded gulpfile
  21. .IP \(bu 2
  22. \fB\-\-color\fP will force gulp and gulp plugins to display colors even when no color support is detected
  23. .IP \(bu 2
  24. \fB\-\-no\-color\fP will force gulp and gulp plugins to not display colors even when color support is detected
  25. .IP \(bu 2
  26. \fB\-\-silent\fP will disable all gulp logging
  27. .RE
  28. .P
  29. The CLI adds process\.env\.INIT_CWD which is the original cwd it was launched from\.
  30. .SS Task specific flags
  31. .P
  32. Refer to this StackOverflow \fIhttp://stackoverflow\.com/questions/23023650/is\-it\-possible\-to\-pass\-a\-flag\-to\-gulp\-to\-have\-it\-run\-tasks\-in\-different\-ways\fR link for how to add task specific flags
  33. .SS Tasks
  34. .P
  35. Tasks can be executed by running \fBgulp <task> <othertask>\fP\|\. Just running \fBgulp\fP will execute the task you registered called \fBdefault\fP\|\. If there is no \fBdefault\fP task gulp will error\.
  36. .SS Compilers
  37. .P
  38. You can find a list of supported languages at interpret \fIhttps://github\.com/tkellen/node\-interpret#jsvariants\fR\|\. If you would like to add support for a new language send pull request/open issues there\.