Skip to content

Latest commit

 

History

History
99 lines (61 loc) · 7.67 KB

using-github-code-search.md

File metadata and controls

99 lines (61 loc) · 7.67 KB
title intro allowTitleToDifferFromFilename versions topics
Using GitHub Code Search
You can use suggestions, completions and saved searches in the upgraded search interface to quickly find what you are looking for across {% data variables.product.prodname_dotcom %}.
true
feature
code-search-upgrade
GitHub search

About using {% data variables.product.prodname_dotcom %} code search

{% data variables.product.prodname_dotcom %} indexes repositories you own and repositories in organizations you are a member of, whether public, private, or internal. This means that you can search across all of your repositories, in addition to the public repositories on {% data variables.product.prodname_dotcom %} that have already been indexed. Only users with permission to view your code will be able to see your code in search results. Forks are indexed and searchable in the same way as other repositories.

Not all code is indexed, and you can currently only search the default branches of repositories. For more information on known limitations, see AUTOTITLE.

{% data reusables.search.code-search-login-requirement %}

Using the search bar

You can search using the search interface on {% data variables.product.prodname_dotcom %}. Using suggestions, completions, and saved searches, you can quickly find what you are looking for, often without having to fully type a query or view the search results page.

For more information about the search syntax of code search, see AUTOTITLE.

{% data reusables.search.non-code-search-explanation %}

  1. In the top navigation of {% data variables.product.prodname_dotcom %}, click the search bar.

  2. Under the search bar, you will see a list of suggestions organized by category, including recent searches and suggested repositories, teams, and projects that you have access to. You can also see a list of saved searches that you have created. For more information on saved searches, see Creating and managing saved searches.

    Screenshot of the {% data variables.product.prodname_dotcom %} search bar. There is a list of search suggestions by category below the search bar.

    If you click on any of the specific suggestions, you will be taken directly to the page for that suggestion (for example, the repository or project page). If you click on a recent or saved search, depending on the type of search, the search query will appear in the search bar or you will be taken to the search results page for the search term.

{% data reusables.search.type-code-search-query-step %}

Screenshot of a search for "repo:octocat/spoon-knife". The code results are outlined in dark orange.

  1. After typing your query, you can also press Enter to go to the full search results view, where you can see each match and a visual interface for applying filters. For more information, see Using the search results view.

{% ifversion copilot %}

Getting answers with {% data variables.product.prodname_copilot_short %} from the search bar

[!NOTE] {% data reusables.copilot.copilot-requires-subscription %}

You can use {% data variables.product.prodname_copilot %} to ask questions about an entire repository directly from the main search box. Simply type your question into the search bar, and {% data variables.product.prodname_copilot_short %} can provide insights or explanations about the repository’s structure, purpose, or specific components. This makes it easy to get quick answers without navigating through multiple files, helping you stay focused and maintain your workflow.

  1. Navigate to a repository on {% data variables.product.github %}.

  2. Press /, or click in the main search box at the top of the page.

  3. In the search box, after repo:OWNER/REPO, type the question you want to ask {% data variables.product.prodname_copilot_short %}.

    For example, you could enter:

    • What does this repo do?
    • Where is authentication implemented in this codebase?
    • How does license file detection work in this repo?
  4. Click Ask {% data variables.product.prodname_copilot_short %}.

    Screenshot of the main search box on {% data variables.product.prodname_dotcom %}. The drop-down option "Ask {% data variables.product.prodname_copilot_short %}" is highlighted with an orange outline.

    The {% data variables.product.prodname_copilot_chat %} panel is displayed and {% data variables.product.prodname_copilot_short %} responds to your request.

{% data reusables.copilot.stop-response-generation %}

{% endif %}

Creating and managing saved searches

  1. In the top navigation of {% data variables.product.prodname_dotcom %}, click the search bar and type saved:.
  2. Under the search bar, in the "Saved queries" section, click {% octicon "plus-circle" aria-hidden="true" %} Manage saved searches.
  3. In the pop-up window, type both the name you want for your saved search and the query you want to save.
  4. To finish creating your saved search, click Create saved search.
  5. To see your saved search, click the search bar. Your saved search will be in the "Saved queries" section. Clicking on a saved search entry will add the query to the search bar and filter the suggestions accordingly.
  6. To manage a saved search, type saved: in the search bar, then click {% octicon "plus-circle" aria-hidden="true" %} Manage saved searches.
    • To edit a saved search, to the right of the search, click {% octicon "pencil" aria-label="The pencil icon" %}.
    • To delete a saved search, to the right of the search, click {% octicon "trash" aria-label="The trash icon" %}.

Using the search results view

To construct a search query, as well as view and filter results, using a visual interface, you can use the {% data variables.search.search_page_url %} or {% data variables.search.advanced_url %}. If you press Enter after typing a search query in the search bar, you will also be taken to the search results view.

On the search results view, you can navigate between different types of search results, including code, issues, pull request, repositories, and more. You can also view and use filters.

Using {% data variables.product.prodname_dotcom %} code search on {% data variables.product.prodname_mobile %}

{% ifversion global-code-search-mobile %}On {% data variables.product.prodname_mobile %}, you can use code search directly from the search bar in the home screen.{% else %} On {% data variables.product.prodname_mobile %}, you can navigate to a repository and use code search on the code in that repository.{% endif %} Code search on {% data variables.product.prodname_mobile %} uses the same syntax as code search on {% data variables.product.prodname_dotcom %}. For more information, see AUTOTITLE.

{% ifversion global-code-search-mobile %}

Once you start typing a search query, you will see a list of completions and suggestions that match your query. You can click on a suggestion to jump to a specific location. As you type more qualifiers, you will see more specific suggestions, such as code files you can jump to directly.

{% else %}

  1. On {% data variables.product.prodname_mobile %}, navigate to the main page of a repository.
  2. Tap {% octicon "file-code" aria-hidden="true" %} Code, then tap the search bar. {% data reusables.search.type-code-search-query-step %}

{% endif %}