Skip to content

Commit

Permalink
Create emote-ssh-stable-commands.md
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
eleanorjboyd authored Dec 16, 2022
1 parent d1fa966 commit b56e43e
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions emote-ssh-stable-commands.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
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.


## Remote-SSH Stable Commands:

#### `opensshremotes.openEmptyWindow`
- parameters: `(args?: IOpenWindowsArgs)` _(see IOpenWindowsArgs definition below)_
- this command is called with the command palette command `Connect to Host..`

#### `opensshremotes.openEmptyWindowInCurrentWindow`
- parameters: `(args?: IOpenWindowsArgs)` _(see IOpenWindowsArgs definition below)_
- this command is called with the command palette command "Connect Current Window to Host..."


#### `opensshremotes.cleanRemoteServer`
- parameters: none
- this command is called with the command palette command "Kill VS Code Server on Host..."

#### `opensshremotes.cleanDevBox`
- parameters: none
- this command is called with the command palette command "Uninstall VS Code Server from Host..."

## Interface Definitions

##### IOpenWindowsArgs Definition
```
interface IOpenWindowsArgs {
host: string;
userName?: string;
port?: number;
}
```


0 comments on commit b56e43e

Please sign in to comment.