From b56e43eee5be867541a9248e3eec6f8cc87f9f29 Mon Sep 17 00:00:00 2001
From: Eleanor Boyd <eleanorboyd@microsoft.com>
Date: Fri, 16 Dec 2022 11:51:10 -0500
Subject: [PATCH] Create emote-ssh-stable-commands.md

Closes https://github.com/microsoft/vscode-remote-release/issues/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.
---
 emote-ssh-stable-commands.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 emote-ssh-stable-commands.md

diff --git a/emote-ssh-stable-commands.md b/emote-ssh-stable-commands.md
new file mode 100644
index 0000000..f948cba
--- /dev/null
+++ b/emote-ssh-stable-commands.md
@@ -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;
+}
+```
+
+