topic Re: How can you add help to a custom search command? in Splunk Search

How can you add help to a custom search command?

Marinus — Mon, 26 Jul 2010 21:09:32 GMT

How can you add help to a custom search command?

Re: How can you add help to a custom search command?

hbazan — Mon, 26 Jul 2010 22:11:25 GMT

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.

Re: How can you add help to a custom search command?

Marinus — Tue, 27 Jul 2010 03:22:51 GMT

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.

Re: How can you add help to a custom search command?

bwooden — Wed, 28 Jul 2010 09:19:05 GMT

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).

Re: How can you add help to a custom search command?

carasso — Thu, 30 Dec 2010 09:35:37 GMT

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

Re: How can you add help to a custom search command?

aovsiannikov — Wed, 26 Dec 2018 13:00:28 GMT

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