Skip to content

Commit ea6b5e9

Browse files
axvmphated
authored andcommitted
Docs: Integrate completion documentation into README (closes #66)
1 parent d6dec21 commit ea6b5e9

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,27 @@ gulp.task(build);
5454

5555
Tasks can be executed by running `gulp <task> <othertask>`. Just running `gulp` will execute the task you registered called `default`. If there is no `default` task, gulp will error.
5656

57+
## Completion
58+
> Thanks to the grunt team, specifically Tyler Kellen
59+
60+
To enable tasks auto-completion in shell you should add `eval "$(gulp --completion=shell)"` in your `.shellrc` file.
61+
62+
###### Bash:
63+
64+
Add `eval "$(gulp --completion=bash)"` to `~/.bashrc`.
65+
66+
###### Zsh:
67+
68+
Add `eval "$(gulp --completion=zsh)"` to `~/.zshrc`.
69+
70+
###### Powershell:
71+
72+
Add `Invoke-Expression ((gulp --completion=powershell) -join [System.Environment]::NewLine)` to `$PROFILE`.
73+
74+
###### Fish:
75+
76+
Add `gulp --completion=fish | source` to `~/.config/fish/config.fish`.
77+
5778
## Compilers
5879

5980
You can find a list of supported languages at https://github.com/js-cli/js-interpret. If you would like to add support for a new language, send pull requests/open issues on that project.

0 commit comments

Comments
 (0)