waveterm/waveterm-docs-old
0
0
Fork 0
mirror of https://github.com/wavetermdev/waveterm-docs-old.git synced 2026-08-05 13:42:53 -07:00
Code Issues Packages Projects Releases Wiki Activity

merge branch 'main' into sshconfig-import

Browse Source
This commit is contained in:
Sylvia Crowe
2024-02-22 00:58:20 -08:00
parent bd9f53be54 2855401ff0
commit add08f143b
6 changed files with 191 additions and 122 deletions
Download Patch File Download Diff File Expand all files Collapse all files
mint.json
+82 -76
View File
@@ -1,78 +1,84 @@
{
"$schema": "https://mintlify.com/schema.json",
"name": "Wave Terminal",
"logo": {
"dark": "/logo/wave-dark.png",
"light": "/logo/wave-light.png"
},
"favicon": "/wave-logo_appicon.svg",
"colors": {
"primary": "#58C142",
"light": "#35A118",
"dark": "#58C142",
"anchors": {
"from": "#58C142",
"to": "#35A118"
}
},
"topbarLinks": [
{
"name": "Support",
"url": "mailto:info@commandline.dev"
}
],
"topbarCtaButton": {
"name": "Download Wave",
"url": "https://www.waveterm.dev/download"
},
"tabs": [
],
"anchors": [
{
"name": "Github",
"icon": "github",
"url": "https://github.com/wavetermdev/waveterm"
},
{
"name": "Join our Discord",
"icon": "discord",
"url": "https://discord.gg/XfvZ334gwU"
}
],
"navigation": [
{
"group": "Get Started",
"pages": [
"introduction",
"quickstart",
"releasenotes"
]
},
{
"group": "Features",
"pages": [
"features/appearance",
"features/connections",
"features/history",
"features/images",
"features/markdown",
"features/sshconfig-imports",
"features/chatGPT"
]
},
{
"group": "Reference",
"pages": [
"reference/faq",
"reference/keyboard",
"reference/slashcommands",
"reference/zsh"
]
}
],
"footerSocials": {
"github": "https://github.com/wavetermdev/waveterm",
"twitter": "https://x.com/wavetermdev",
"linkedin": "https://www.linkedin.com/company/commandlinedev"
}
"$schema":"https://mintlify.com/schema.json",
"name":"Wave Terminal",
"logo":{
"dark":"/logo/wave-dark.png",
"light":"/logo/wave-light.png"
},
"favicon":"/wave-logo_appicon.svg",
"colors":{
"primary":"#58C142",
"light":"#35A118",
"dark":"#58C142",
"anchors":{
"from":"#58C142",
"to":"#35A118"
}
},
"topbarLinks":[
{
"name":"Support",
"url":"mailto:info@commandline.dev"
}
],
"topbarCtaButton":{
"name":"Download Wave",
"url":"https://www.waveterm.dev/download"
},
"tabs":[
],
"anchors":[
{
"name":"Github",
"icon":"github",
"url":"https://github.com/wavetermdev/waveterm"
},
{
"name":"Join our Discord",
"icon":"discord",
"url":"https://discord.gg/XfvZ334gwU"
},
{
"name":"WaveTerm Blog",
"icon":"square-up-right",
"url":"https://blog.waveterm.dev"
}
],
"navigation":[
{
"group":"Get Started",
"pages":[
"introduction",
"quickstart",
"releasenotes"
]
},
{
"group":"Features",
"pages":[
"features/appearance",
"features/connections",
"features/history",
"features/images",
"features/markdown",
"features/chatGPT",
"features/sshconfig-imports"
]
},
{
"group":"Reference",
"pages":[
"reference/faq",
"reference/keyboard",
"reference/slashcommands",
"reference/waveshell"
]
}
],
"footerSocials":{
"github":"https://github.com/wavetermdev/waveterm",
"twitter":"https://x.com/wavetermdev",
"linkedin":"https://www.linkedin.com/company/commandlinedev"
}
}
reference/faq.mdx
+28 -6
View File
@@ -12,11 +12,7 @@ Wave telemetry is very minimal, anonymized, completely optional, and you can opt
## What shells does Wave Terminal support?
We currently only support `bash`. Your environment (including variables, functions, and aliases) is read from the standard bash startup files (.bash_profile). In order to customize Wave's environment at startup Wave will set the environment variable `WAVESHELL`. If you are currently using `zsh`, you might have to transfer some of your `.zprofile` setup into your `.bash_profile`. See [Using Wave Terminal with zsh](https://docs.waveterm.dev/reference/zsh) for more information.
## Why do international characters appear as question marks?
It is a known issue that Wave Terminal does not support international unicode characters yet. We are investigating a solution and tracking the issue [here](https://github.com/wavetermdev/waveterm/issues/88)
We currently support `bash` and `zsh`. Your environment (including variables, functions, and aliases) is read from the standard bash and zsh startup files (.bash_profile and .zshrc). In order to customize Wave's environment at startup Wave will set the environment variable `WAVESHELL`.
## How do I specify SSH options such as PubkeyAcceptedKeyTypes?
@@ -38,4 +34,30 @@ Right now we don't support changing the font. We plan on supporting this in the
## Are ligatures supported in Wave?
Wave Terminal uses the JetBrains Mono font which includes 142 code-specific ligatures. These ligatures are supported in the command prompt area and in the terminal output.
Wave Terminal uses the JetBrains Mono font which includes 142 code-specific ligatures. These ligatures are supported in the command prompt area and in the terminal output.
## I've changed my .bashrc / .bash_profile files, how can I reload them?
To reload your configuration files and reset the environment of a tab, you should run the command `reset` or (`/reset`).
Wave loads your bash configuration by executing bash with the -l and -i options (so it is an interactive login shell). That means any changes need to be in your .bash_profile to take effect (unless your .bash_profile also sources your .bashrc). Note that sessions are persistent in Wave, so even if you change your startup files the changes won't take effect in any currently open tabs (unless you explicitly run `reset`).
## Do I need to install mshell/waveshell on remote machines to use Wave Terminal?
No, it is not required. You can use Wave as a normal terminal by just executing a traditional `ssh` command at the Wave prompt. That will create a command block that runs your remote ssh session. When running ssh like this mshell/waveshell will not be installed on your remote machine.
For more information see [WaveShell Helper](/reference/waveshell)
## What is mshell/waveshell, why does it need to be installed on machines I connect to?
Content Moved. See [WaveShell Helper](/reference/waveshell)
## Can I switch my shell type within an already running tab?
Yes (must have Wave v0.6.0 or later). If you run `/reset shell=zsh` or `/reset shell=bash` the shell will be changed. Note that your cwd and environment will be reset as if this were a new session. You can tell if the shell switch was successful by checking the shell type flag that appears at the bottom right hand corner of the command input box.
## "The shell state for this tab is invalid", what's going on?
When building v0.6.0 we noticed some irregularities in how we were storing bash shell state. Specifically if your rcfiles produced any spurious output (invalid aliases was a common culprit), the shell state might be saved, but in a broken way. While migrating to v0.6.0 we flagged any of these invalid states and show this message.
Clicking "reset shell state" (or running the slash command `/reset`) will force Wave to re-read your bash config files and produce a new valid state. Note that after running the reset, your cwd and environment will be reset as if this was a new session.
reference/keyboard.mdx
+18 -2
View File
@@ -2,6 +2,8 @@
title: Keyboard Shortcuts
---
Most of Wave's global keyboard shortcuts use Cmd/Alt because we generally try to reserve the Ctrl key for interacting with terminal commands directly or for system shortcuts like Copy, Paste, Select All, etc. The shortcuts listed in the chart below are for MacOS. Linux/Windows keybindings use `Alt` in place of `Cmd`.
## Global Keys
* **Cmd-I** - focus the command-input
@@ -10,12 +12,16 @@ title: Keyboard Shortcuts
* **Cmd-H** - open command history view
* **Cmd-[** - move one tab left
* **Cmd-]** - move one tab right
* **Cmd-W** - close the current tab
* **Cmd-P** - open tab switcher (quickly switch to a new tab by name)
* **Cmd-R** - restart currently selected command (command does not need to be focused, just selected)
* **Cmd-Shift-R** - restart last visibile command in current tab
* **Cmd-UpArrow** or **Cmd-PageUp** - move selected command up
* **Cmd-DownArrow** or **Cmd-PageDown** - move selected command down
* **Cmd-[digit]** - select nth tab
* **Cmd-Control-[digit]** - select nth workspace
* **Cmd-Ctrl-S** - toggle sidebar on/off
* **Esc** - close/toggle extra info panel
* **Esc** - close/toggle extra info panel (escape will also close or cancel most modals)
## When Command Input is Focused
@@ -25,6 +31,7 @@ title: Keyboard Shortcuts
* **Ctrl-R** - open command history view
* **Ctrl-C** - clear command input
* **Esc** - close/toggle extra info panel
* **Ctrl-Space** - open AI help for writing commands
* **Ctrl-W** - cuts word to left of cursor (from readline)
* **Ctrl-U** - cuts entire line to left of cursor (from readline)
* **Ctrl-Y** - paste (from readline)
@@ -57,4 +64,13 @@ Note that these keybindings only function when the command is no longer running.
* **Up-Arrow** - scroll up
* **Down-Arrow** - scroll down (when
* **Page-Up** - scroll one page up
* **Page-Down** - scroll one page down
* **Page-Down** - scroll one page down
* **Cmd-D** - delete command block
## When AI Help for Writing Commands is Open
* **ESC** - close help
* **Ctrl-L** - clear chat history
* **UpArrow** - select previous command block
* **DownArrow** - select next command block
* **Enter** - submit question, or if a command block is selected, replace the current command with the text from the command block
reference/waveshell.mdx
+17
View File
@@ -0,0 +1,17 @@
---
title: WaveShell Helper
---
WaveShell (also known as MShell) is a small open-source helper program that facilitiates advanced communication between your local Wave Terminal instance and a remote machine. It enables Wave Terminal to provide advanced terminal features like command blocks, persistent sessions, and detailed universal command history.
Note that waveshell is does *not* communicate with any external services, does not open any ports, and does *not* send any information or telemetry to Wave Terminal or Command Line Inc servers. It communicates exclusively with the local Wave Terminal running on your machine via a standard SSH connection over stdin/stdout. It does not require or try to acquire any additional privledges on the remote computer (unless of course you explicitly request it run with sudo privledges to execute sudo commands). It is run only when Wave Terminal establishes a connection to the remote machine, and does not stay resident (as a daemon) when the connection is not active.
WaveShell Source (Apache 2.0 Licensed) is available here: https://github.com/wavetermdev/waveterm/tree/main/waveshell
## Do I need to install mshell/waveshell on remote machines to use Wave Terminal?
No, it is not required. You can run a traditional `ssh` command at the Wave prompt. That will create a single command block that runs your remote ssh session. When running ssh like this mshell/waveshell will not be installed on your remote machine.
## What remote architectures does WaveShell support?
MacOS (x64 and arm64), and Linux (x64 and arm64).
reference/zsh.mdx
-38
View File
@@ -1,38 +0,0 @@
---
title: Using Wave Terminal with zsh
---
Wave Terminal currently only supports `bash`. Your environment (including variables, functions, and aliases) is read from the standard bash startup files (.bash_profile). In order to customize Wave's environment at startup Wave will set the environment variable `WAVESHELL`. If you are currently using `zsh`, you might have to transfer some of your `.zprofile` setup into your `.bash_profile have Wave pick up your path and other environment settings.
> Note that supporting zsh is high on our technical roadmap and we expect to have have at least partial (if not full) zsh support in the next couple of months.
## How do I get brew commands to work?
If using brew, get brew commands to work by running the `brew shellenv` command in a Wave Terminal tab session. This will update the current tab session. To update all sessions in Wave Terminal, add the `shellenv` command to your .bashrc file. See below for further instructions.
<AccordionGroup>
<Accordion icon="scroll" title="Update .bashrc with codeedit">
Use codeedit inside Wave Terminal to modify your bashrc e.g.
```
/codeedit .bashrc
```
copy and paste this into your ./bashrc then save the file.
```
eval "$(/opt/homebrew/bin/brew shellenv)
```
</Accordion>
<Accordion icon="rectangle-terminal" title="Update .bashrc at command line">
Run the following command in a terminal to update your .bashrc
```
echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> ~/.bashrc
```
</Accordion>
</AccordionGroup>
<Tip>
Run brew command ```brew help shellenv``` for more information on managing brew setup.
</Tip>
## How do I get nvim to work in Wave Terminal?
Any applications installed with brew will likely need a PATH update, see the previous FAQ for further details on how to do this.
releasenotes.mdx
+46
View File
@@ -4,6 +4,52 @@ title: Release Notes
Download the latest build here: https://waveterm.dev/download
### v0.6.3 - 02/19/2024
Patch release to fix [github #302](https://github.com/wavetermdev/waveterm/issues/302) which caused the last line of terminal output to be cut off for certain screen zoom settings (system zoom/resolution or in-app zooming.)
### v0.6.2 - 02/14/2024
Quick patch release for a large zsh performance bug where we were re-running the interactive zsh configs for every command execution causing a notable slowdown in performance.
* Bug fix: fixed slow zsh command performance and overeager zsh re-initialization
* Bug fix: fixed ssh config import
### v0.6.1 - 01/31/2024
* Tab/workspace indicators now show if commands are running
* Keybindings fixes for international keyboards and linux. Keybindings now use the same letter key on non-US keyboards. MacOS keybindings that use the "Cmd" key now map to "Alt" (instead of the "Windows" key) on Linux and Windows.
* Restart Command -- use the restart icon, or Cmd-R to restart the selected command. Restarted commands run with the same directory and environment as when they were first launched.
* Cmd-Shift-R will always restart the most recent command in the tab (no matter which command is selected).
* Can use the mouse to resize and collapse the left sidebar.
* Other bug fixes and improvements
### v0.6.0 - 01/23/2024
* **zsh support**
* Bug fix: International Characters (and emojis!) now display properly in the terminal and when using AI features. [github #88](https://github.com/wavetermdev/waveterm/issues/88) [github #190](https://github.com/wavetermdev/waveterm/issues/190)
* ChatGPT help with writing commands, use Ctrl-Space from the command prompt.
* Cmd-P tab switcher. Quickly switch to tabs and workspaces by name (like VSCode's Cmd-P file switcher)
* Zoom - use Cmd +/- to zoom UI in and out (for smaller or larger monitors)
* Clickable Links in Terminal Output (hold Cmd while clicking)
* Tab Indicators - gray/green/red indicator lights show on tabs when running commands have additional output (gray), complete successfully (green), or fail (red).
* Import button added to the Connections Screen to quickly add connections to hosts defined in your .ssh/config file.
* Cmd-D keyboard shortcut to delete the selected command block (also added a trash icon to allow deletion using the mouse)
* Cmd-W keyboard shortcut to close a tab [github #181](https://github.com/wavetermdev/waveterm/issues/181)
* Settings is now its own main screen (no longer in a modal)
* A popup now informs users that waveshell (aka mshell) will be installed on remote machines when adding Wave connections
* Allow dots and underscores in connection aliases, allow backslash in ssh usernames, and allow multiple connections to the same machine if they are using different ports.
* Big update to screen/command deletion and history to make it more intuitive. Clearing or deleting a tab, or deleting a command block no longer removes the affected commands from history.
* New UI for open-source license acknowledgements
* Bug fix: Escape should now close modals and screens
* Bug fix: fixed issue with new connection login screens "flashing" making it impossible to login using passwords and OTPs for certain users [github #213](https://github.com/wavetermdev/waveterm/issues/213)
* Bug fix: quote paths to go backends to allow install paths with spaces or special characters
* More useful "Disconnected" Modal that shows the last 50 lines of wavesrv.log for easier error reporting
* Other bug fixes and performance improvements [github #188](https://github.com/wavetermdev/waveterm/issues/188)
* Dropped support for linux-arm64 (still supported as a remote connection, but not for the Wave Terminal desktop app)
Note: if you get errors while using zsh, please report them on [github](https://github.com/wavetermdev/waveterm/issues) or in our Discord. To switch shells in an already open tab run: `reset shell=bash` or `reset shell=zsh`. To reload your rc/init files after editing them (to to just reset your terminal state) run `reset`.
### v0.5.3 - 12/21/2023
* Minor release, fixes workspace deletion bug [github #174](https://github.com/wavetermdev/waveterm/issues/174)