-
Notifications
You must be signed in to change notification settings - Fork 306
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
eleanorjboyd
wants to merge
8
commits into
main
Choose a base branch
from
doc-for-stable-commands
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+27
−0
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
b56e43e
Create emote-ssh-stable-commands.md
eleanorjboyd a6f405b
Merge branch 'main' into doc-for-stable-commands
eleanorjboyd 67523e0
Update emote-ssh-stable-commands.md
eleanorjboyd b73087f
add extra info
eleanorjboyd 77407e2
remove unnecessary line
eleanorjboyd e00872d
Update remote-ssh-stable-commands.md
eleanorjboyd c1c24ae
Merge branch 'main' into doc-for-stable-commands
eleanorjboyd 5f3107c
Merge branch 'main' into doc-for-stable-commands
eleanorjboyd File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
|
||
|
||
## 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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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; | ||
} | ||
``` | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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