How can you add help to a custom search command?

[Marinus]

How can you add help to a custom search command?

[bwooden · Accepted solution]

To create a search-assistant or type-ahead...

I sneak a look at the searchbnf.conf.spec.

Then I create (or append) $SPLUNK_HOME/etc/system/local/searchbnf.conf (often leveraging the searchbnf.conf.example as a guide).

[carasso]

If your custom search command is in an app, you should also put the searchbnf.conf in the app as well.

[aovsiannikov]

Is it possible to auto generate searchbnf.conf from command class docstring? Are there any util for this?

[Marinus]

When you enter a command in the search interface it gives you online help for the command, including examples. I'd like to do the same for a custom command.

[hbazan]

What do you mean by "help", do you want to explain what's in the results? we've used a csv input table for something like that, and then a join, so each file has a new column with the appropriate explanation of each value.