From d82286b1cb9ea592521847ebf18f01c1364f9ed8 Mon Sep 17 00:00:00 2001 From: Sylvie Crowe <107814465+oneirocosm@users.noreply.github.com> Date: Mon, 28 Oct 2024 21:16:36 -0700 Subject: [PATCH] Add WSL to Docs (#81) * feat: add docs for wsl connections This specifies a couple small things related to connections. It also adds the new wsh command for wsl connections. * fix: syntax error and capitalization --- docs/connections.mdx | 10 ++++++---- docs/wsh.mdx | 36 ++++++++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+), 4 deletions(-) diff --git a/docs/connections.mdx b/docs/connections.mdx index a075e53..ae88e10 100644 --- a/docs/connections.mdx +++ b/docs/connections.mdx @@ -6,25 +6,27 @@ title: "Connections" # Connections -Wave allows users to connect to various machines and unify them together in a way that preserves the unique behavior of each. At the moment, this only extends to ssh remote connections but we hope to expand this to other types of connections soon. +Wave allows users to connect to various machines and unify them together in a way that preserves the unique behavior of each. At the moment, this extends to SSH remote connections and local WSL connections. ## Access a Connection in a Block -The easiest way to access connections is to click the icon. From there, you can type `[user]@[host]` for the desired ssh remote. Alternatively, if the connection already exists in the dropdown list, you can either click it or navigate to it with arrow keys and press enter to connect. +The easiest way to access connections is to click the icon. From there, you can either type `[user]@[host]` for a desired SSH remote or type `wsl://` for a desired WSL distribution. Alternatively, if the connection already exists in the dropdown list, you can either click it or navigate to it with arrow keys and press enter to connect. ## What are wsh Shell Extensions? `wsh` is a small program that helps manage waveterm regardless of which machine you are currently connected to. In order to not interrupt the normal flow of the remote session, we install it on your remote machine at `~/.waveterm/bin/wsh`. Then, when wave connects to your connection (and only when wave connects to your connection), `~/.waveterm/bin` is added to your `PATH` for that individual session. For more info on what `wsh` is capable of, see [wsh command](/wsh). And if you wish to view the source code of `wsh`, you can find it [here](https://github.com/wavetermdev/waveterm/tree/main/cmd/wsh). ## Add a New Connection to the Dropdown -The values that are loaded into the dropdown by default are obtained by parsing your `~/.ssh/config` and `/etc/ssh/ssh_config` files. Adding a new connection is as simple as adding a new `Host` to one of these files, typically the `~/.ssh/config` file. +The SSH values that are loaded into the dropdown by default are obtained by parsing your `~/.ssh/config` and `/etc/ssh/ssh_config` files. Adding a new connection is as simple as adding a new `Host` to one of these files, typically the `~/.ssh/config` file. + +WSL values are added by searching the installed WSL distributions as they appear in the Windows Registry. ## SSH Config Parsing At the moment, we are capable of parsing any SSH config file that does not contain the `Match` keyword. This keyword is incompatible with a library we are using, but we are hoping to fix that soon. While all other valid keywords are parsed, we only support the functionality of a small subset of them at the moment: | Keyword | Description | |---------|-------------| | Host | The pattern to match when attempting to connect via `[user]@[host]`. We list hosts that do not contain any wildcards characters (`*`, `?`, or `!`). Even if a host pattern contains wildcards, it will still be parsed when determining the values associated with the keys as usual.| -| User | The user of the ssh remote connection. This will default to the current user on the local machine if not specified.| +| User | The user of the SSH remote connection. This will default to the current user on the local machine if not specified.| | Port | The port to connect to the remote on. `22` is the default if not specified.| | IdentityFile | This can be specified more than once per host. It gives the path to a private identity file (id_rsa, id_ed25519, id_ecdsa, etc.) that is used to authenticate the connection. Each will be tried in order, and they can be encrypted with a passphrase if desired. If no value is set, the default is to try in order: ~/.ssh/id_rsa, ~/.ssh/id_ecdsa, ~/.ssh/id_ecdsa_sk, ~/.ssh/id_ed25519_sk, ~/.ssh/id_dsa.| |BatchMode| If set to true, user interaction via password, challenge/response, and publickey passphrase authentication will be disabled. It is set to false by default.| diff --git a/docs/wsh.mdx b/docs/wsh.mdx index 62fe5a7..c4e5f92 100644 --- a/docs/wsh.mdx +++ b/docs/wsh.mdx @@ -88,6 +88,16 @@ This will use Wave's internal ssh implementation to connect to the specified rem --- +## wsl + +``` +wsh wsl [-d ] +``` + +This will connect to a WSL distribution on the local machine. It will use the default if no distribution is provided. + +--- + ## web You can search for a given url using: @@ -119,36 +129,62 @@ This command gives the status of all connections made since waveterm started. ### reinstall +For ssh connections, ``` wsh conn reinstall [user@host] ``` +For wsl connections, +``` +wsh conn reinstall [wsl://] +``` + This command reinstalls the Wave Shell Extensions on the specified connection. ### disconnect +For ssh connections, ``` wsh conn disconnect [user@host] ``` +For wsl connections, +``` +wsh conn disconnect [wsl://] +``` + This command completely disconnects the specified connection. This will apply to all blocks where the connection is being used ### connect +For ssh connections, ``` wsh conn connect [user@host] ``` +For wsl connections, +``` +wsh conn connect [wsl://] +``` + This command connects to the specified connection but does not create a block for it. ### ensure +For ssh connections, ``` wsh conn ensure [user@host] ``` +For wsl connections, +``` +wsh conn ensure [wsl://] +``` + This command connects to the specified connection if it isn't already connected. +--- + ### setconfig ```