/docs/_posts/2018-01-23-grep-on-the-fly-in-spacevim.md

https://github.com/SpaceVim/SpaceVim · Markdown · 99 lines · 68 code · 31 blank · 0 comment · 0 complexity · 4891abc1ca338a49e962eaa628d12ce1 MD5 · raw file 

    

  1. ---
    2. 

  2. title: "Grep on the fly in SpaceVim"
    3. 

  3. categories: [feature, blog]
    4. 

  4. description: "Grep and replace asynchronously, display searching results on the fly based on user input"
    5. 

  5. image: https://user-images.githubusercontent.com/13142418/80607963-b704d300-8a68-11ea-99c4-5b5bd653cb24.gif
    6. 

  6. commentsID: "Grep on the fly"
    7. 

  7. comments: true
    8. 

  8. ---
    9. 

  9. 

  10. # [Blogs](../blog/) >> Asynchronous grep on the fly
    11. 

  11. 

  12. {{ page.date | date_to_string }}
    13. 

  13. 

  14. FlyGrep means **grep on the fly**, it will update the result as you type. Of course, it is running
    15. 

  15. asynchronously. Before using this feature, you need to install a searching tool. FlyGrep works
    16. 

  16. through search tools: `ag`, `rg`, `ack`, `pt` and `grep`, Choose one you like.
    17. 

  17. 

  18. This ia a built-in plugin in SpaceVim, and we also separated a plugin : [FlyGrep.vim](https://github.com/wsdjeg/FlyGrep.vim)
    19. 

  19. 

  20. ## Install
    21. 

  21. 

  22. In linux os, flygrep use grep by default, if you want a more fast tool, you can choose one of following:
    23. 

  23. 

  24. - [ripgrep(rg)](https://github.com/BurntSushi/ripgrep)
    25. 

  25. - [the_silver_searcher(ag)](https://github.com/ggreer/the_silver_searcher)
    26. 

  26. - [the_platinum_searcher(pt)](https://github.com/monochromegane/the_platinum_searcher)
    27. 

  27. 

  28. ## Features
    29. 

  29. 

  30. - **Search in a project**
    31. 

  31. 

  32. In SpaceVim, you can use `SPC s p` or `SPC s /` to search in the current project.
    33. 

  33. 

  34. ![searching project](https://user-images.githubusercontent.com/13142418/80607963-b704d300-8a68-11ea-99c4-5b5bd653cb24.gif)
    35. 

  35. 

  36. - **Search in current file**
    37. 

  37. 

  38. You can use `SPC s s` to search in the current file. To search word under the cursor, you can press `SPC s S`.
    39. 

  39. 

  40. ![searching current file](https://user-images.githubusercontent.com/13142418/35278847-e0032796-0010-11e8-911b-2ee8fd81aed2.gif)
    41. 

  41. 

  42. - **Search in all loaded buffers**
    43. 

  43. 

  44. To searching in all loaded buffers, you need to press `SPC s b`, and you can also use `SPC s B` to search word under the point.
    45. 

  45. 

  46. ![searching-loaded-buffer](https://user-images.githubusercontent.com/13142418/35278996-518b8a34-0011-11e8-9a7a-613668398ee2.gif)
    47. 

  47. 

  48. - **Search in an arbitrary directory**
    49. 

  49. 

  50. If you want to searching in a different directory instead of current directory, you can
    51. 

  51. use `SPC s f`. Then insert the path of the arbitrary directory.
    52. 

  52. 

  53. - **Search in a project in the background**
    54. 

  54. 

  55. If you need background searching, you can press `SPC s j`, after searching is done, the index will be displayed on statusline. you can use `SPC s l` to list all the search results.
    56. 

  56. 

  57. ## Key bindings
    58. 

  58. 

  59. The search commands in SpaceVim are organized under the `SPC s` prefix with the next key is the tool to use and the last key is the scope. For instance `SPC s a b` will search in all opened buffers using `ag`.
    60. 

  60. 

  61. If the last key (determining the scope) is uppercase then the current word under the cursor is used as default input for the search. For instance `SPC s a B` will search with word under cursor.
    62. 

  62. 

  63. If the tool key is omitted then a default tool will be automatically selected for the search. This tool corresponds to the first tool found on the system of the list `g:spacevim_search_tools`, the default calling sequence is `rg`, `ag`, `pt`, `ack` then `grep`. For instance `SPC s b` will search in the opened buffers using `pt` if `rg` and `ag` have not been found on the system.
    64. 

  64. 

  65. The tool keys are:
    66. 

  66. 

  67. | Tool | Key |
    68. 

  68. | ---- | --- |
    69. 

  69. | ag   | a   |
    70. 

  70. | grep | g   |
    71. 

  71. | ack  | k   |
    72. 

  72. | rg   | r   |
    73. 

  73. | pt   | t   |
    74. 

  74. 

  75. The available scopes and corresponding keys are:
    76. 

  76. 

  77. | Scope                      | Key |
    78. 

  78. | -------------------------- | --- |
    79. 

  79. | opened buffers             | b   |
    80. 

  80. | files in a given directory | f   |
    81. 

  81. | current project            | p   |
    82. 

  82. 

  83. **Within FlyGrep buffer:**
    84. 

  84. 

  85. | Key Bindings      | Descriptions                      |
    86. 

  86. | ----------------- | --------------------------------- |
    87. 

  87. | `<Esc>`           | close FlyGrep buffer              |
    88. 

  88. | `<Enter>`         | open item in current window       |
    89. 

  89. | `Ctrl-t`          | open item in new tab              |
    90. 

  90. | `<Tab>`           | move cursor line down             |
    91. 

  91. | `Ctrl-j`          | move cursor line down             |
    92. 

  92. | `Shift-<Tab>`     | move cursor line up               |
    93. 

  93. | `Ctrl-k`          | move cursor line up               |
    94. 

  94. | `<Backspace>`     | remove last character             |
    95. 

  95. | `Ctrl-w`          | remove the word before the cursor |
    96. 

  96. | `Ctrl-u`          | remove the line before the cursor |
    97. 

  97. | `Ctrl-k`          | remove the line after the cursor  |
    98. 

  98. | `Ctrl-a`/`<Home>` | Go to the beginning of the line   |
    99. 

  99. | `Ctrl-e`/`<End>`  | Go to the end of the line         |
    100.