diff options
Diffstat (limited to 'doc/user/project/repository/file_finder.md')
-rw-r--r-- | doc/user/project/repository/file_finder.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/doc/user/project/repository/file_finder.md b/doc/user/project/repository/file_finder.md new file mode 100644 index 00000000000..576001d4305 --- /dev/null +++ b/doc/user/project/repository/file_finder.md @@ -0,0 +1,45 @@ +--- +disqus_identifier: 'https://docs.gitlab.com/ee/workflow/file_finder.html' +--- + +# File finder + +> [Introduced][gh-9889] in GitLab 8.4. + +The file finder feature allows you to search for a file in a repository using the +GitLab UI. + +You can find the **Find File** button when in the **Files** section of a +project. + +![Find file button](img/file_finder_find_button.png) + +For those who prefer to keep their fingers on the keyboard, there is a +[shortcut button](../../shortcuts.md) as well, which you can invoke from _anywhere_ +in a project. + +Press `t` to launch the File search function when in **Issues**, +**Merge requests**, **Milestones**, even the project's settings. + +Start typing what you are searching for and watch the magic happen. With the +up/down arrows, you go up and down the results, with `Esc` you close the search +and go back to **Files**. + +## How it works + +The File finder feature is powered by the [Fuzzy filter](https://github.com/jeancroy/fuzz-aldrin-plus) library. + +It implements a fuzzy search with highlight, and tries to provide intuitive +results by recognizing patterns that people use while searching. + +For example, consider the [GitLab CE repository][ce] and that we want to open +the `app/controllers/admin/deploy_keys_controller.rb` file. + +Using fuzzy search, we start by typing letters that get us closer to the file. + +**Protip:** To narrow down your search, include `/` in your search terms. + +![Find file button](img/file_finder_find_file.png) + +[gh-9889]: https://github.com/gitlabhq/gitlabhq/pull/9889 "File finder pull request" +[ce]: https://gitlab.com/gitlab-org/gitlab-foss/tree/master "GitLab CE repository" |