Grunt (node) - How to show available tasks?

Question

While beeing used to using Rakefile, Cakefile and Jakefile, they all had some convenient way of listing the available tasks.

Like

jake -T 

jake db:dump      # Dump the database  
jake db:load      # Populate the database

..etc.

or even filtering "jake -T dum", to only show "the "jake db:dump" task.

So, is there a way to do the same using grunt? I was thinking of maybe creating a default task that iterates the entire grunt config object and write it to stdout via console.log, but does someone know a better way?

Thanks.

I don't want to answer my own question, but I came up with an extremely dirty hack. `grunt -h | sed -e '/Available tasks/,/Tasks run/!d'` Surely someone with experience can come up with something better? :) — borestad, Jan 04 '13 at 02:30

score 17 · Answer 1 · edited May 23 '17 at 10:31

17

grunt --help lists available tasks, as per following answer.

Example output

.....

Available tasks
             clean  Clean files and folders. *                                
              jade  Compile jade templates. *                                 
        web_server  A Web Server similar to Python's SimpleHTTPServer, with   
                 Cross-Origin Resource Sharing and No-Cache options. *

edited May 23 '17 at 10:31

Community

1
1

answered Aug 23 '14 at 10:55

Atilla Ozgur

14,339
3
49
69

1

This is the right answer and should be voted to the top. – Dan Oct 23 '14 at 14:25
The answer [below](https://stackoverflow.com/a/20229531/3384609) is better – Clintm Dec 27 '17 at 22:10

Ragnarokkr · Answer 2 · 2015-03-31T16:13:06.213

11

As far as I know the only way (obviously without hacks) to show the available tasks is using the -h or --help option.

As you can see in grunt-cli source they clearly take care about only -h (help), -V (version), and -v (verbose) options.

So, I think that currently you have to create your own custom task to reach your goal.

edited Mar 31 '15 at 16:13

answered Jan 09 '13 at 17:14

Ragnarokkr

2,328
2
21
31

score 9 · Answer 3 · answered Nov 26 '13 at 22:41

There is a better way! I'm currently working on a separate plugin, grunt-available-tasks to achieve this functionality. Add it to your project with:

npm install grunt-available-tasks --save-dev

Then run grunt availabletasks to get a list of your tasks. You may want to alias this with tasks to save some typing:

grunt.registerTask('tasks', ['availabletasks']);

Then, with some configuration you can get lists like this one:

$ grunt tasks
Running "availabletasks" task

Deployment Tasks
doc                => Build the documentation.
production         => Build a complete distribution for production; stricter linting and a full browser test.

Development Tasks
default            => Build a development distribution.
watch               > Run predefined tasks whenever watched files change.

Done, without errors.

You can filter, group and sort tasks using a configuration object in your Gruntfile. A comprehensive list of options is available in the README.

Task "availabletasks" not found. Likely for the same reason that I'm trying to list available tasks (troubleshooting). — rainabba, Jun 30 '14 at 23:10
I think I posted this answer before I made the task a multi task; you'll need to do something like grunt.initConfig({ availabletasks: { tasks: {} } }); - find the rest of the options in the README. :-) — Ben, Jul 01 '14 at 00:15

Grunt (node) - How to show available tasks?

3 Answers3