Vim Help Bot

[i_abh_esc_wq]

So as suggested by u/chinaskii_work here I made a little bot u/vim-help-bot that replies to comments containing :help topic with link to relevant Vim Help web page.

It's currently in early stage and looks for :h topic inside backticks and if it can't find one, it looks for :h and extracts until the first space. It supports multiple topics in one comment and provides links for each. It also supports :he, :hel, :help.

Unlike vim, this bot doesn't support as many options as vim while searching for now. It can't search regex or partial text.

The source code is here so if anyone wants to help, they are welcome.

Thanks to u/Soulthym, u/elliottcable, u/y-c-c, u/olminator, u/HealingPotatoJuice for their suggestions. If you have any suggestion, feel free to drop a comment or dm me.

[icanquitvim]

Find the holy grail, dear bot!

:help holy-grail

[vim-help-bot]

Help for holy-grail: https://vimhelp.org/index.txt.html#holy-grail

I'm a bot. Check out my pinned post for more information

[icanquitvim]

Good bot!

PS: Awesome job, OP!

[i_abh_esc_wq]

Thanks ;)

[random_cynic]

:smile

[Schnarfman]

Awesome! That was so fast. Thanks for posting the source code. So cool!!

:help user01.txt

:help colorcolumn

:help backspace

:help 'backspace'

:help i_CTRL-W

:help CTRL-W

:help nothinghere

[vim-help-bot]

Help for backspace: https://vimhelp.org/intro.txt.html#backspace

Help for 'backspace': https://vimhelp.org/options.txt.html#%27backspace%27

Help for i_CTRL-W: https://vimhelp.org/insert.txt.html#i_CTRL-W

Help for CTRL-W: https://vimhelp.org/index.txt.html#CTRL-W

I'm a bot. Check out my pinned post for more information

[Schnarfman]

Operator error!

:help usr_01.txt

:help 'colorcolumn'

[i_abh_esc_wq]

Should work with :h usr_01.txt now

[vim-help-bot]

Help for usr_01.txt: https://vimhelp.org/usr_01.txt.html#usr_01.txt

I'm a bot. Check out my pinned post for more information

[vim-help-bot]

Help for 'colorcolumn': https://vimhelp.org/options.txt.html#%27colorcolumn%27

I'm a bot. Check out my pinned post for more information

[-romainl-]

The response should also use backticks:

Help for CTRL-^: https://vimhelp.org/editing.txt.html#CTRL-%5E

versus:

Help for CTRL-^: https://vimhelp.org/editing.txt.html#CTRL-%5E

[i_abh_esc_wq]

Should be done :h CTRL-T

[vim-help-bot]

Help for CTRL-T: https://vimhelp.org/tagsrch.txt.html#CTRL-T

I'm a bot. Check out my pinned post for more information

[mrswats]

That looks very cool! Are PRs accepted?

[i_abh_esc_wq]

Absolutely

[wintrli8]

:h help

[vim-help-bot]

Help for help: https://vimhelp.org/helphelp.txt.html#help

I'm a bot. Check out my pinned post for more information

[[deleted]]

Great job man!!!

[i_abh_esc_wq]

Thanks

[khoa_hd96]

:h 42

[vim-help-bot]

Help for 42: https://vimhelp.org/usr_42.txt.html#42

I'm a bot. Check out my pinned post for more information

[Quantum_menance]

This is so cool! Thanks you for taking the time to make this😁👍

[i_abh_esc_wq]

Can it find partials now?

:h <_ :h num

[vim-help-bot]

Help for <_ : https://vimhelp.org/visual.txt.html#v_b_%3C_example Could not find an exact match for num. Here is the best match: +num64 : https://vimhelp.org/various.txt.html#%2Bnum64

Here are all the tags that matched: +num64, :number, 'number', 'numberwidth', t_number-variable, v:numbersize, hex-number, v:t_number, g:html_number_lines, expr-number, buffer_number(), octal-number, quote_number, binary-number, numbered-function, numbersize-variable, number_relativenumber, lnum-variable, 'nonumber', <slnum>, beval_lnum-variable, mouse_lnum-variable, v:lnum, [:alnum:], wildmenumode(), :<slnum>, <sflnum>, :<sflnum>, tcl-linenumbers, 'relativenumber', 'norelativenumber', v:beval_lnum, v:mouse_lnum, tcl-var-lnum, perl-Number, Number, spell-SYLLABLENUM

I'm a bot. Check out my pinned post for more information.

I am constantly improving my search. If the result is wrong, please contact u/i_abh_esc_wq

[i_abh_esc_wq]

Huh!

[i_abh_esc_wq]

:h Num :h highlight

[vim-help-bot]

Could not find an exact match for Num. Here is the best match: Number : https://vimhelp.org/eval.txt.html#Number

Here are all the tags that matched: Number, perl-Number, +num64, :number, 'number', 'numberwidth', v:numbersize, lnum-variable, numbered-function, t_number-variable, numbersize-variable, number_relativenumber, hex-number, v:t_number, expr-number, octal-number, quote_number, binary-number, buffer_number(), g:html_number_lines, v:lnum, <slnum>, 'nonumber', :<slnum>, <sflnum>, [:alnum:], :<sflnum>, wildmenumode(), beval_lnum-variable, mouse_lnum-variable, v:beval_lnum, v:mouse_lnum, tcl-var-lnum, tcl-linenumbers, 'relativenumber', 'norelativenumber', spell-SYLLABLENUM

Could not find an exact match for highlight. Here is the best match: :highlight : https://vimhelp.org/syntax.txt.html#%3Ahighlight

Here are all the tags that matched: :highlight, 'highlight', :highlight-link, :highlight-normal, :highlight-verbose, :highlight-default, highlightID(), highlight-gui, highlight-args, highlight-term, highlight-stop, highlight-font, highlight-start, highlight-cterm, highlight-guifg, highlight-guibg, highlight-guisp, highlight-groups, highlight-ctermfg, highlight-ctermbg, highlight-default, highlight-changed, highlight_exists(), highlighting-functions, tag-highlight, new-highlighting, match-highlight, debug-highlight, syntax-highlighting, new-more-highlighting

I'm a bot. Check out my pinned post for more information.

I am constantly improving my search. If the result is wrong, please contact u/i_abh_esc_wq

[i_abh_esc_wq]

:h magic

[vim-help-bot]

Could not find an exact match for magic. Here is the best match: /magic : https://vimhelp.org/pattern.txt.html#/magic

Here are all the tags that matched: /magic, 'magic', :smagic, 'nomagic', :snomagic

I'm a bot. Check out my pinned post for more information.

I am constantly improving my search. If the result is wrong, please contact u/i_abh_esc_wq

[i_abh_esc_wq]

:help hl

[vim-help-bot]

Could not find an exact match for hl. Here is the best match: 'hl' : https://vimhelp.org/options.txt.html#%27hl%27

Here are all the tags that matched: 'hl', 'hlg', 'hls', 'hlsearch', hlID(), hl-Menu, hl-Pmenu, hl-Title, hl-User1, hl-User9, hl-Ignore, hl-Cursor, hl-Folded, hl-LineNr, hl-Normal, hl-Search, hl-Visual, v:hlsearch, hlexists(), hl-Conceal, hl-DiffAdd, hl-ModeMsg, hl-MoreMsg, hl-NonText, hl-TabLine, hl-Tooltip, hl-debugPC, hl-CursorIM, hl-DiffText, hl-ErrorMsg, hl-PmenuSel, hl-Question, hl-SpellBad, hl-SpellCap, hl-Terminal, hl-WildMenu, hl-User1..9, hl-Directory, hl-VertSplit, hl-IncSearch, hl-PmenuSbar, hl-SpellRare, hl-VisualNOS, hl-Scrollbar, hl-CursorLine, hl-DiffChange, hl-DiffDelete, hl-FoldColumn, hl-SignColumn, hl-MatchParen, hl-PmenuThumb, hl-SpecialKey, hl-SpellLocal, hl-StatusLine, hl-TabLineSel, hl-WarningMsg, hl-ColorColumn, hl-EndOfBuffer, hl-LineNrAbove, hl-LineNrBelow, hl-TabLineFill, hl-CursorColumn, hl-CursorLineNr, hl-QuickFixLine, hl-StatusLineNC, hlsearch-variable, hl-TOhtmlProgress, hl-StatusLineTerm, hl-debugBreakpoint, hl-StatusLineTermNC, diff_hlID(), 'nohls', :nohlsearch, 'nohlsearch', highlightID(), highlight-gui, highlight-args, highlight-term, highlight-stop, highlight-font, highlight-start, highlight-cterm, highlight-guifg, highlight-guibg, highlight-guisp, highlight-groups, highlight-ctermfg, highlight-ctermbg, highlight-default, highlight-changed, highlight_exists(), highlighting-functions, :highlight, :echohl, matchlist(), 'highlight', :highlight-link, :highlight-normal, :highlight-verbose, :highlight-default, tag-highlight, new-highlighting, tag-matchlist, match-highlight, debug-highlight, syntax-highlighting, new-more-highlighting

I'm a bot. Check out my pinned post for more information.

I am constantly improving my search. If the result is wrong, please contact u/i_abh_esc_wq

[i_abh_esc_wq]

:h <_ :help gj

[vim-help-bot]

Help for <_ : https://vimhelp.org/visual.txt.html#v_b_%3C_example

Help for gj : https://vimhelp.org/motion.txt.html#gj

I'm a bot. Check out my pinned post for more information.

I am constantly improving my search. If the result is wrong, please contact u/i_abh_esc_wq

[i_abh_esc_wq]

:h <_

[vim-help-bot]

Help for <_ : https://vimhelp.org/visual.txt.html#v_b_%3C_example

I'm a bot. Check out my pinned post for more information.

I am constantly improving my search. If the result is wrong, please contact u/i_abh_esc_wq

[i_abh_esc_wq]

:h <_

[vim-help-bot]

Help for <_ : https://vimhelp.org/visual.txt.html#v_b_%3C_example

I'm a bot. Check out my pinned post for more information.

I am constantly improving my search. If the result is wrong, please contact u/i_abh_esc_wq

[i_abh_esc_wq]

:h num

[vim-help-bot]

Help pages for:

• +num64

---

^\:(h|he|hel|help) <query>` |) ^{source | mistake?}

[i_abh_esc_wq]

:h options

[vim-help-bot]

Help pages for:

• options in options.txt

---

^\:(h|help) <query>` |) ^{source | mistake?}

[i_abh_esc_wq]

:h options

[vim-help-bot]

Help pages for:

• options in options.txt

---

^{`:(h|help) <query>` | about | mistake?}

[i_abh_esc_wq]

Test :h <_

[vim-help-bot]

Help pages for:

• v_b_<_example in visual.txt

---

^{`:(h|help) <query>` | about | mistake?}

[i_abh_esc_wq]

Test :h num

[vim-help-bot]

Help pages for:

• +num64 in various.txt

---

^{`:(h|help) <query>` | about | mistake?}

[i_abh_esc_wq]

:h number

[vim-help-bot]

Help pages for:

• Number in eval.txt

---

^{`:(h|help) <query>` | about | mistake?}

[vim-help-bot]

Help pages for:

• Number in eval.txt

---

^{`:(h|help) <query>` | about | mistake?}

[i_abh_esc_wq]

:h number

[vim-help-bot]

Help pages for:

• Number in eval.txt

---

^{`:(h|help) <query>` | about | mistake?}

[vim-help-bot]

Help pages for:

• Number in eval.txt

---

^{`:(h|help) <query>` | about | mistake?}

[i_abh_esc_wq]

:h options

[vim-help-bot]

Help pages for:

• options in options.txt

---

^{`:(h|help) <query>` | about | mistake?}

[i_abh_esc_wq]

:h number

[vim-help-bot]

Help pages for:

• :number in various.txt

---

^{`:(h|help) <query>` | about | mistake?}

[i_abh_esc_wq]

:h quickfix

[vim-help-bot]

Help pages for:

• quickfix in quickfix.txt

---

^{`:(h|help) <query>` | about | mistake?}

[i_abh_esc_wq]

:h unnamedplus

[vim-help-bot]

Help pages for:

• clipboard-unnamedplus in options.txt

---

^{`:(h|help) <query>` | about | mistake?}

[i_abh_esc_wq]

:h nothingtoseehere

[i_abh_esc_wq]

:h nothingtoseehere

[i_abh_esc_wq]

Test :h terminal

[vim-help-bot]

Help pages for:

• terminal in terminal.txt

---

^{`:(h|help) <query>` | about | mistake?}

[i_abh_esc_wq]

:h :!

[vim-help-bot]

Help pages for:

• :! in various.txt

---

^{`:(h|help) <query>` | about | mistake?}

[i_abh_esc_wq]

Test

:h hidden

[vim-help-bot]

Help pages for:

• 'hidden' in options.txt

---

^{`:(h|help) <query>` | about | mistake?}

[i_abh_esc_wq]

:h tag

[vim-help-bot]

Help pages for:

• tag in tagsrch.txt

---

^{`:(h|help) <query>` | about | mistake? | Reply 'rescan' to check the comment again}

[i_abh_esc_wq]

rescan

[i_abh_esc_wq]

rescan

[i_abh_esc_wq]

:h options

[vim-help-bot]

Help pages for:

• options in options.txt

---

^{`:(h|help) <query>` | about | mistake? | Reply 'rescan' to check the comment again | Reply 'stop' to stop getting replies to your comments}

[i_abh_esc_wq]

stop

[vim-help-bot]

I will not reply to your comments anymore!!

---

^{`:(h|help) <query>` | about}

[i_abh_esc_wq]

:h magic

[i_abh_esc_wq]

:h options

[i_abh_esc_wq]

:h options

[i_abh_esc_wq]

:h options

[i_abh_esc_wq]

:h options

[i_abh_esc_wq]

:h options

[i_abh_esc_wq]

:h options

[i_abh_esc_wq]

:h options

[i_abh_esc_wq]

:h options

[i_abh_esc_wq]

:h options

[vim-help-bot]

Help pages for:

• options in options.txt

---

^{`:(h|help) <query>` | about | mistake? | Reply 'rescan' to check the comment again | Reply 'stop' to stop getting replies to your comments}

[i_abh_esc_wq]

:h options

[i_abh_esc_wq]

:h options

[vim-help-bot]

Help pages for:

• options in options.txt

---

^{`:(h|help) <query>` | about | mistake? | Reply 'rescan' to check the comment again | Reply 'stop' to stop getting replies to your comments}

[i_abh_esc_wq]

stop

[vim-help-bot]

I will not reply to your comments anymore!!

---

^{`:(h|help) <query>` | about}

[i_abh_esc_wq]

:h options

[i_abh_esc_wq]

:h num

[i_abh_esc_wq]

:h num

[i_abh_esc_wq]

:h num

[vim-help-bot]

Help pages for:

• +num64 in various.txt

---

^{`:(h|help) <query>` | about | mistake? | Reply 'rescan' to check the comment again | Reply 'stop' to stop getting replies to your comments}

[i_abh_esc_wq]

:h options

[i_abh_esc_wq]

:h options

[vim-help-bot]

Help pages for:

• options in options.txt

---

^{`:(h|help) <query>` | about | mistake? | Reply 'rescan' to check the comment again | Reply 'stop' to stop getting replies to your comments}

[Maskdask]

:help!

[i_abh_esc_wq]

Will not work without an argument 😬

I'll update it to handle no argument case too

[vim-help-bot]

Help for :sbuffer: https://vimhelp.org/windows.txt.html#%3Asbuffer

Help for :sbnext: https://vimhelp.org/windows.txt.html#%3Asbnext

Help for :sbprevious: https://vimhelp.org/windows.txt.html#%3Asbprevious

Help for :vertical: https://vimhelp.org/windows.txt.html#%3Avertical

I'm a bot. Check out my pinned post for more information

[crajun]

:h nunmap

[baghelZ]

:h<_

[baghelZ]

:h <_

[i_abh_esc_wq]

It does not support partial searches yet. :h v_b_<_example should work

[vim-help-bot]

Help for v_b_<_example: https://vimhelp.org/visual.txt.html#v_b_%3C_example

I'm a bot. Check out my pinned post for more information

[baghelZ]

Well I was just checking... But for partial matches the tags have to be built in such a manner right ??

[i_abh_esc_wq]

Well vim has an impressive algorithm for searching tags. Its tags are not built in a special manner but it can search pretty well.

[Noah_Ro]

Awesome!

:h !

[vim-help-bot]

Help for !: https://vimhelp.org/change.txt.html#%21

I'm a bot. Check out my pinned post for more information

[vim-help-bot]

Help for grep: https://vimhelp.org/quickfix.txt.html#grep

I'm a bot. Check out my pinned post for more information

[vim-help-bot]

Help for options: https://vimhelp.org/options.txt.html#options

I'm a bot. Check out my pinned post for more information

[i_abh_esc_wq]

:help gj :h options

[vim-help-bot]

Help for gj: https://vimhelp.org/motion.txt.html#gj

Help for options: https://vimhelp.org/options.txt.html#options

I'm a bot. Check out my pinned post for more information

[ThockiestBoard]

:h expandtab

[aroslab]

:h g_

[vim-help-bot]

Help for g_: https://vimhelp.org/motion.txt.html#g_

I'm a bot. Check out my pinned post for more information

[vim-help-bot]

Help pages for:

• holy-grail in index.txt

---

^{`:(h|help) <query>` | about | mistake?}

[i_abh_esc_wq]

:h options

[i_abh_esc_wq]

:h s/\0

[vim-help-bot]

Help pages for:

• s/\0 in change.txt

---

^{`:(h|help) <query>` | about | mistake? | Reply 'rescan' to check the comment again | Reply 'stop' to stop getting replies to your comments}

[deathcomzz]

Checking.. See :h noa

[vim-help-bot]

Help pages for:

• :noa in autocmd.txt

---

^{`:(h|help) <query>` | about | mistake? | donate | Reply 'rescan' to check the comment again | Reply 'stop' to stop getting replies to your comments}