Skip to content

Commit e497666

Browse files
Merge pull request #5352 from MicrosoftDocs/main638838774565842784sync_temp
For protected branch, push strategy should use PR and merge to target branch method to work around git push error
2 parents 6999af4 + bd9e69b commit e497666

9 files changed

+133
-31
lines changed

.github/copilot-instructions.md

Lines changed: 25 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,27 @@
11
When writing documentation, follow the following guidelines:
22

3-
Follow the style of the [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/).
4-
5-
Headings should be in sentence case, not title case. Don't use gerunds in titles.
6-
7-
Use the active voice whenever possible, and second person to address the reader directly.
8-
9-
Use a conversational tone with contractions.
10-
11-
Be concise.
12-
13-
Break up long sentences.
14-
15-
Use the present tense for instructions and descriptions. For example, "The method returns a value" instead of "The method will return a value."
16-
17-
Do not use "we" or "our" to refer to the authors of the documentation.
18-
19-
Use the imperative mood for instructions. For example, "Call the method" instead of "You should call the method."
20-
21-
Use "might" instead of "may" to indicate possibility. For example, "This method might throw an exception" instead of "This method may throw an exception."
22-
23-
Use the Oxford comma in lists of three or more items.
24-
25-
Number ordered list items all as "1." instead of "1.", "2.", etc. Use bullets for unordered lists.
26-
27-
Use **bold** when referring to UI elements. Use `code style` for file names and folders, custom types, and other text that should never be localized.
28-
29-
Put raw URLs within angle brackets.
30-
31-
Include links to related topics and resources where appropriate. Use relative links if the target file lives in this repo. If you add a link to another page on learn.microsoft.com that's not in this repo, remove https://learn.microsoft.com/en-us from the link.
32-
33-
If you're adding a new Markdown file, it should be named in all lowercase with hyphens separating words. Also, omit any filler words such as "the" or "a" from the file name.
3+
- Follow the style of the [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/).
4+
- Headings should be in sentence case, not title case. Don't use gerunds in titles.
5+
- Use the active voice whenever possible, and second person to address the reader directly.
6+
- Use a conversational tone with contractions.
7+
- Be concise.
8+
- Break up long sentences.
9+
- Use the present tense for instructions and descriptions. For example, "The method returns a value" instead of "The method will return a value."
10+
- Don't use "we" or "our" to refer to the authors of the documentation.
11+
- Use the imperative mood for instructions. For example, "Call the method" instead of "You should call the method."
12+
- Use "might" instead of "may" to indicate possibility. For example, "This method might throw an exception" instead of "This method may throw an exception."
13+
- Use the Oxford comma in lists of three or more items.
14+
- Number ordered list items all as "1." instead of "1.", "2.", etc. Use bullets for unordered lists.
15+
- Use **bold** when referring to UI elements. Use `code style` for file names and folders, custom types, and other text that should never be localized.
16+
- Put raw URLs within angle brackets.
17+
- When you are going to refer to another file or an article on the web, use a link. For example, "For more information, see [C++ language reference](../cpp/cpp-language-reference.md)."
18+
- Include links to related topics and resources where appropriate. Use relative links if the target file lives in this repo. If you add a link to another page on learn.microsoft.com that's not in this repo, remove https://learn.microsoft.com/en-us from the link.
19+
- If you're adding a new Markdown file, it should be named in all lowercase with hyphens separating words. Also, omit any filler words such as "the" or "a" from the file name.
20+
- If you're adding a new Markdown file, the following indicates where it should go the folder structure. If you aren't sure, ask. The following folder structure is how it looks on my hard drive. To map to GitHub, for example, C:\Users\twhitney\repos\cpp-docs-pr\docs\linux is docs/linux
21+
If the file is about Linux, put it in the C:\Users\twhitney\repos\cpp-docs-pr\docs\linux folder.
22+
If the file is about the C++ Standard Template Library (STL), put it in the C:\Users\twhitney\repos\cpp-docs-pr\docs\standard-library folder.
23+
If the file is about the C runtime, put it in the C:\Users\twhitney\repos\cpp-docs-pr\docs\c-runtime-library folder.
24+
If the file is about the C++ language, put it in the C:\Users\twhitney\repos\cpp-docs-pr\docs\cpp folder.
25+
If the file is about a C++ feature specific to the Visual Studio IDE, put it in the C:\Users\twhitney\repos\cpp-docs-pr\docs\ide folder.
26+
If the file is about the build process or modules, put it in the C:\Users\twhitney\repos\cpp-docs-pr\docs\build\reference folder.
27+
If the file is about Build Insights, put it in the C:\Users\twhitney\repos\cpp-docs-pr\docs\build-insights folder.
Loading
Loading
Loading
Loading
9.85 KB
Loading
13.3 KB
Loading

docs/linux/remote-file-explorer.md

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
---
2+
title: "Remote file explorer"
3+
description: "Learn how to use Remote File Explorer to view, upload, and download files on a remote machine form within Visual Studio."
4+
ms.topic: how-to
5+
ms.date: 05/21/2025
6+
---
7+
# Remote File Explorer
8+
9+
Learn how to use **Remote File Explorer** to view, upload, and download files on a remote machine from Visual Studio. With **Remote File Explorer**, perform common file operations such as:
10+
11+
- Upload files from your local machine to a remote machine
12+
- Download files from a remote machine to your local machine
13+
- Create folders on a remote machine
14+
- Delete files and folders on a remote machine
15+
- Rename files and folders on a remote machine
16+
- Search for files and folders on a remote machine
17+
18+
## Prerequisites
19+
20+
Visual Studio version 17.6 or later.
21+
22+
Ensure that the **Linux and embedded development with C++** workload is installed. Run the Visual Studio Installer and ensure that the **Linux and embedded development with C++** workload is selected. Also ensure that the **Remote File Explorer for Linux** component is selected, and update your installation if necessary.
23+
24+
:::image type="content" source="media/linux-workload.png" alt-text="Screenshot of the Visual Studio Installer. The **Linux and embedded development with C++** workload is selected. In the installation details pane, Remote File Explorer for Linux is selected.":::
25+
26+
Install and configure Secure Shell (SSH) on the remote machine. To install SSH on Linux, run these commands on the remote machine:
27+
28+
```bash
29+
sudo apt update
30+
sudo apt install openssh-server
31+
sudo systemctl start ssh
32+
sudo systemctl status ssh
33+
```
34+
35+
## View and edit files on a remote machine
36+
37+
In these examples, the remote machine is a Windows Subsystem for Linux instance running on localhost port 22. The project is a new CMake project created in Visual Studio. The sample project is on the remote machine in the `C:\Users\{username}\projects\` folder.
38+
39+
To open the **Remote File Explorer** in Visual Studio, choose **View** > **Other Windows** > **Remote File Explorer**.
40+
41+
:::image type="content" source="media/remote-file-explorer-menu-item.png" alt-text="Screenshot of the Visual Studio View menu. Remote File Explorer is highlighted.":::
42+
43+
The **Remote File Explorer** window opens:
44+
45+
:::image type="content" source="media/remote-file-explorer.png" alt-text="Screenshot of the Remote File Explorer. The folder system on the remote machine is visible.":::
46+
47+
If you see a message to select or create a new connection in the **Connection Manager**, ensure that the SSH server is running on the remote machine. If your remote machine is running on Windows Subsystem for Linux (WSL), ensure that the WSL instance is running. Make sure the Visual Studio debug target dropdown is set to the remote instance. To connect to a different remote machine, in the **Remote File Explorer** window's **Select the host target** dropdown, select the remote target. It may appear in a form such as `username@hostname:port`. For example, `username@localhost:22`. You can also select **Add new connection** to add a new connection to the **Connection Manager**. For more information, see [Connection manager](connect-to-your-remote-linux-computer.md).
48+
49+
Open and edit files directly from the **Remote File Explorer**. To open a file, double-click the file in the **Remote File Explorer** window. The file opens in the editor window. You can also right-click the file and select **Open** from the context menu or press **Ctrl+Enter**. When you save the file, the changes are saved directly to the remote machine.
50+
51+
## Upload files to a remote machine
52+
53+
To upload files or directories to the remote machine, right-click the folder in the **Remote File Explorer** window where you want to upload files, and select **Upload**.
54+
55+
:::image type="content" source="media/remote-file-explorer-upload.png" alt-text="Screenshot of the Remote File Explorer showing the Upload a directory and Upload files menu options.":::
56+
57+
Use the folder explorer window that opens to select the file or folder you want to upload. You can drag and drop files from your local machine onto the **Remote File Explorer** window. Alternatively, use the **Upload Files** or **Upload Folder** buttons to choose the items to upload:
58+
59+
## Download files from a remote machine
60+
61+
To download files or directories from the remote machine, right-click the folder or file in the **Remote File Explorer** window that you want to download and select **Download**.
62+
63+
:::image type="content" source="media/remote-file-explorer-download.png" alt-text="Screenshot of the Remote File Explorer displaying the menu option: Download 'asset.txt'.":::
64+
65+
Use the folder explorer window that opens to select where to download the file or folder. You can also use the **Download Item** button to choose the item you want to download.
66+
67+
## Monitor and cancel file operations
68+
69+
Monitor the progress of uploading or downloading items in the status window at the bottom of the **Remote File Explorer** window. Select the **Cancel** button to stop the operation.
70+
71+
:::image type="content" source="media/remote-file-explorer-progress.png" alt-text="Screenshot of the Remote File Explorer showing the progress indicator. The Cancel button is highlighted.":::
72+
73+
## Other file operations
74+
75+
Rename files and folders, create new folders, delete files and folders, and search for files and folders.
76+
77+
- Rename a file or folder: right-click the file or folder and select **Rename** from the context menu, or select the rename button on the toolbar. The filename becomes editable. Type the new name for the item and press **Enter**.
78+
- Create a new folder: right-click in the **Remote File Explorer** window and select **New Folder**. Enter a name for the new folder and press **Enter**.
79+
- Delete a file or folder: right-click the file or folder and select **Delete** from the context menu, or select the delete button on the toolbar. Confirm the deletion in the dialog that appears. Deleting files or folders from the remote machine is a permanent action and can't be undone.
80+
- Refresh the view: right-click in the **Remote File Explorer** window and select **Refresh** from the context menu, or select the refresh button on the toolbar, or press **F5**. It only refreshes the view of what is selected. If you have a folder selected, it refreshes the view of that folder. If you have a file selected, it refreshes the view of that file.
81+
- Search for files: enter text in the search box at the top of the **Remote File Explorer** window to find folders or files. The search is case-insensitive and searches all files and folders under the selected item. If a folder is selected, it searches all files and folders in that folder. If a file is selected, it searches all files and folders in the same directory as that file.
82+
83+
## Remote File Explorer toolbar buttons
84+
85+
The **Remote File Explorer** toolbar lets you access remote file operations:
86+
87+
:::image type="content" source="media/remote-file-explorer-toolbar.png" alt-text="Screenshot of the Remote File Explorer toolbar." :::
88+
89+
The highlighted buttons are, from left to right:
90+
91+
- **+**: Create a new Remote Explorer window.
92+
- **Home**: Go to the `$HOME` directory of the currently signed-in user on the remote machine.
93+
- **Settings**: Open the settings for the **Remote File Explorer**.
94+
- **Upload Files**: Upload files from your local machine to the remote machine.
95+
- **Upload Folder**: Upload a folder from your local machine to the remote machine.
96+
- **Download Item**: Download a file or folder from the remote machine to your local machine.
97+
- **Refresh Item**: Refresh the view of the selected item.
98+
- **Rename Item**: Rename a file or folder on the remote machine.
99+
- **Delete Item**: Delete a file or folder on the remote machine.
100+
- **Search**: Search for files or folders on the remote machine.
101+
102+
## See also
103+
104+
- [The Remote File Explorer tool window of Visual Studio (video)](/shows/pure-virtual-cpp-2023/the-remote-file-explorer-tool-window-of-visual-studio)
105+
- [Connection manager](connect-to-your-remote-linux-computer.md)
106+
- [Create a CMake Linux project in Visual Studio](cmake-linux-project.md)

docs/linux/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ items:
77
items:
88
- name: Connect to your remote Linux computer
99
href: ../linux/connect-to-your-remote-linux-computer.md
10+
- name: Remote File Explorer
11+
href: ../linux/remote-file-explorer.md
1012
- name: Set up FIPS-compliant secure remote Linux development
1113
href: ../linux/set-up-fips-compliant-secure-remote-linux-development.md
1214
- name: ConnectionManager reference

0 commit comments

Comments
 (0)