Skip to content

Commit b56e43e

Browse files
authored
Create emote-ssh-stable-commands.md
Closes #7549 We got this request from an extension developer, in addition to just writing this doc we would have to commit to maintaining these functions. I think this is reasonable given how vital they are to the core functionality of the Remote-SSH extension. If this is carried through, comments should be added alongside the functions and the interface to alert future developers.
1 parent d1fa966 commit b56e43e

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

emote-ssh-stable-commands.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
The Remote-SSH extenions is a private repos that other extensions rely on for varying functionality. Below is a list of commands that we will do our best to keep stable similar to an API. These commands, now published externally here, will be maintained and changes will not be made without sufficent warning to allow for other dependent extensions to function correctly.
2+
3+
4+
## Remote-SSH Stable Commands:
5+
6+
#### `opensshremotes.openEmptyWindow`
7+
- parameters: `(args?: IOpenWindowsArgs)` _(see IOpenWindowsArgs definition below)_
8+
- this command is called with the command palette command `Connect to Host..`
9+
10+
#### `opensshremotes.openEmptyWindowInCurrentWindow`
11+
- parameters: `(args?: IOpenWindowsArgs)` _(see IOpenWindowsArgs definition below)_
12+
- this command is called with the command palette command "Connect Current Window to Host..."
13+
14+
15+
#### `opensshremotes.cleanRemoteServer`
16+
- parameters: none
17+
- this command is called with the command palette command "Kill VS Code Server on Host..."
18+
19+
#### `opensshremotes.cleanDevBox`
20+
- parameters: none
21+
- this command is called with the command palette command "Uninstall VS Code Server from Host..."
22+
23+
## Interface Definitions
24+
25+
##### IOpenWindowsArgs Definition
26+
```
27+
interface IOpenWindowsArgs {
28+
host: string;
29+
userName?: string;
30+
port?: number;
31+
}
32+
```
33+
34+

0 commit comments

Comments
 (0)