Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create remote-ssh-stable-commands.md #7725

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
27 changes: 27 additions & 0 deletions remote-ssh-stable-commands.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
The Remote-SSH extension is a private repo that other extensions rely on for varying functionality. Below is a list of commands that we will comitt to keeping stable like an API. These commands, now published externally here, will be maintained.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think any of this paragraph of necessary, you can just delete it




## Remote-SSH Stable Commands:

`opensshremotes.openEmptyWindow` - Opens a new window and attempts to connect to the remote provided through the `args`
- parameters: [`(args?: IOpenWindowsArgs)`](#IOpenWindowsArgs-Definition)
- returns: none
- this command is called with the command palette command "Connect to Host.."

`opensshremotes.openEmptyWindowInCurrentWindow` - Attempts to connect to the remote provided through the `args` argument but in the current VS Code window
- parameters: [`(args?: IOpenWindowsArgs)`](#IOpenWindowsArgs-Definition)
- returns: none
- this command is called with the command palette command "Connect Current Window to Host..."

## Interface Definitions

##### IOpenWindowsArgs Definition
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why does this go from a level 2 to level 5 markdown header?

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