Skip to content

Latest commit

 

History

History
143 lines (112 loc) · 6.68 KB

configuring-a-default-editor-in-github-desktop.md

File metadata and controls

143 lines (112 loc) · 6.68 KB
title intro redirect_from versions shortTitle
Configuring a default editor in GitHub Desktop
You can configure {% data variables.product.prodname_desktop %} to open files in your project with your preferred text editor or integrated development environment (IDE).
/desktop/getting-started-with-github-desktop/configuring-a-default-editor
/desktop/installing-and-configuring-github-desktop/configuring-a-default-editor
/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor
/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor-in-github-desktop
fpt ghec ghes
*
*
*
Configure default editor

Introduction

{% data variables.product.prodname_desktop %} provides support for a number of editors, and also allows you to select a custom editor if your preferred editor is not supported. If you installed an editor while {% data variables.product.prodname_desktop %} was open you will need to quit and reopen {% data variables.product.prodname_desktop %} in order for the editor to be detected.

Supported editors

{% mac %}

{% endmac %}

{% windows %}

{% endwindows %}

Configuring a default editor

{% mac %}

{% data reusables.desktop.mac-select-desktop-menu %}

  1. In the Settings window, select Integrations. Screenshot of the "Settings" window. In the left sidebar, the "Integrations" option is highlighted in blue and outlined in orange.
  2. Under "External Editor", use the dropdown menu to select the editor you want to set as your default.
  3. Click Save.

{% endmac %}

{% windows %}

{% data reusables.desktop.windows-choose-options %}

  1. In the Options window, select Integrations. Screenshot of the "Options" window. In the left sidebar, the "Integrations" option is highlighted in blue and outlined in orange.
  2. Under "External Editor", use the dropdown menu to select the editor you want to set as your default.
  3. Click Save.

{% endwindows %}

Configuring a custom editor

{% data reusables.desktop.mac-select-desktop-menu %}

  1. In the Settings window, select Integrations. Screenshot of the "Settings" window. In the left sidebar, the "Integrations" option is highlighted in blue and outlined in orange.
  2. Under "External Editor", use the dropdown menu to select Configure Custom Editor.
  3. Click Choose to open the system dialog to navigate to the path of your custom editor.
  4. Under "Arguments", enter any arguments you would like to use after the "%TARGET_PATH%" variable. Reference supporting documentation for your custom editor to ensure you have the arguments set correctly, as invalid arguments can prevent the editor from launching in {% data variables.product.prodname_desktop %}.
  5. Click Save.

Opening a repository in the default editor

To open the current repository in the default editor, you can use the menu bar:

  1. In the menu bar, select Repository.
  2. Click Open in default editor

If you want to open another repository in the default editor, you can use the repository list.

  1. In the upper-left corner of {% data variables.product.prodname_desktop %}, to the right of the current repository name, click {% octicon "triangle-down" aria-label="The triangle-down icon" %}.
  2. Right-click the repository, then click Open in default editor.

{% mac %}

Tip

You can use the Shift+Command+A keyboard shortcut to open a repository in the default editor.

{% endmac %}

{% windows %}

Tip

You can use the Ctrl+Shift+A keyboard shortcut to open a repository in the default editor.

{% endwindows %}

Opening a file in the default editor

  1. Navigate to the "Changes" tab in the left sidebar.
  2. Double-click on the file, or right-click on the file and select Open in default editor.