Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/connections.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -78,4 +78,4 @@ In addition to the regular ssh config file, wave also has its own config file to

## Managing Connections with the CLI

The `wsh` command gives some commands specifically for interacting with the connections. You can view these [here](/wsh#conn).
The `wsh` command gives some commands specifically for interacting with the connections. You can view these [here](/wsh-reference#conn).
27 changes: 14 additions & 13 deletions docs/docs/gettingstarted.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: "Getting Started"
import { PlatformProvider, PlatformSelectorButton, PlatformItem } from "@site/src/components/platformcontext.tsx";
import { Kbd } from "@site/src/components/kbd.tsx";

Wave Terminal combines the power of a traditional terminal with modern graphical capabilities, letting you seamlessly mix CLI operations with web browsing, file previews, AI assistance, and more. This guide will help you get started.
Wave Terminal is a modern terminal that includes graphical capabilities like web browsing, file previews, and AI assistance alongside traditional terminal features. This guide will help you get started.

## Installation

Expand Down Expand Up @@ -61,23 +61,24 @@ You can also download installers directly from our [Downloads page](https://www.
### Tabs and Blocks

- **Tabs**: Like browser tabs, these help organize your work. Create new tabs with <Kbd k="Cmd:t"/>.
- **Blocks**: The building blocks of Wave. Each block can be a terminal, web browser, file preview, or other widget.
- **Layout**: Blocks can be dragged, dropped, and resized to create your ideal workspace layout.
- **Blocks**: The building blocks of Wave. Each block can be a terminal, web browser, file preview, AI chat, or other widget.
- **Layout**: Blocks can be dragged, dropped, and resized to create your ideal layout.

### Key Features

1. **Terminal Integration**
1. **Terminal Features**

- Full terminal emulation with modern features
- Support for your preferred shell (bash, zsh, fish, etc.)
- The `wsh` command provides special integration with Wave features
- Works with common shells (bash, zsh, fish)
- Supports standard terminal features (readline, control sequences, etc)
- Includes the `wsh` command for interacting with Wave's GUI features
- GPU accelerated (on most platforms)

2. **Graphical Widgets**

- File previews (images, markdown, code with syntax highlighting)
- Built-in web browser
- System monitoring
- AI assistance
- Preview files (images, video, markdown, code with syntax highlighting)
- Browse web pages
- Ask questions and get AI help directly from the terminal (set up multiple AI models)
- Basic system monitoring graphs

3. **Remote Connections**
- Easy SSH connections with the connection button <i className="fa-sharp fa-laptop"/>
Expand All @@ -86,7 +87,7 @@ You can also download installers directly from our [Downloads page](https://www.

## Quick Start Guide

1. **Open Your First Terminal**
1. **Open Your First New Tab**

- New Wave tabs start with a single terminal block
- Use it just like your regular terminal
Expand All @@ -99,7 +100,7 @@ You can also download installers directly from our [Downloads page](https://www.
wsh view ~/Documents

# Open a webpage
wsh web github.com
wsh web open github.com

# Get AI assistance
wsh ai "how do I find large files in my current directory?"
Expand Down
7 changes: 4 additions & 3 deletions docs/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ import { Card, CardGroup } from "@site/src/components/card.tsx";

# Welcome to Wave Terminal

Wave is an [open-source](https://github.com/wavetermdev/waveterm) terminal that adds the ability to launch graphical widgets, controlled and integrated directly with the CLI. We support MacOS, Linux, and Windows ([Getting Started](./gettingstarted)).
Wave is an [open-source](https://github.com/wavetermdev/waveterm) terminal that combines traditional terminal features with graphical capabilities like file previews, web browsing, and AI assistance. It runs on MacOS, Linux, and Windows ([Getting Started](./gettingstarted)).

Wave isn't just another terminal emulator; it's a rethink on how terminals are built. For too long there has been a disconnect between the CLI and the web. If you want fast, keyboard-accessible, easy-to-write applications, you use the CLI, but if you want graphical interfaces, native widgets, copy/paste, scrolling, variable font sizes, then you'd have to turn to the web. Wave's goal is to bridge that gap.
Modern development involves constantly switching between terminals and browsers - checking documentation, previewing files, monitoring systems, and using AI tools. Wave brings these graphical tools directly into the terminal, letting you control them from the command line. This means you can stay in your terminal workflow while still having access to the visual interfaces you need.

![Wave Screenshot](./img/wave-screenshot.webp)

Expand Down Expand Up @@ -48,7 +48,7 @@ Wave isn't just another terminal emulator; it's a rethink on how terminals are b
description="Explore built-in tools to extend your terminal’s functionality."
/>
<Card
href="./wsh-command"
href="./wsh"
icon="fa-file-magnifying-glass"
title="wsh Command"
description="Control Wave and launch widgets directly from the command line."
Expand All @@ -69,6 +69,7 @@ Other References:

- [Configuration](./config)
- [Custom Widgets](./customwidgets)
- [Full wsh reference](./wsh-reference)
- [Telemetry](./telemetry)
- [FAQ](./faq)
- [Release Notes](./releasenotes)
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/layout.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ While we define a 5-child limit for each node in the tree when automatically pla

### Delete a block

You can delete blocks by clicking the <i className="fa-sharp fa-xmark-large"/> button in the top-right corner of the block, by right-clicking on the block header and selecting "Close Block" from the context menu, or by running the [`wsh deleteblock` command](./wsh#deleteblock). Alternatively, the currently focused block/widget can be closed by pressing <Kbd k="Cmd:w"/>
You can delete blocks by clicking the <i className="fa-sharp fa-xmark-large"/> button in the top-right corner of the block, by right-clicking on the block header and selecting "Close Block" from the context menu, or by running the [`wsh deleteblock` command](./wsh-reference#deleteblock). Alternatively, the currently focused block/widget can be closed by pressing <Kbd k="Cmd:w"/>

When you delete a block, the layout tree will be automatically adjusted to minimize the tree depth.

Expand Down
8 changes: 4 additions & 4 deletions docs/docs/releasenotes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ sidebar_position: 200
Wave Terminal v0.10.0 introduces workspaces, making it easier to manage multiple work environments. We've added powerful new command execution capabilities with `wsh run`, allowing you to launch and control commands in dedicated blocks. This release also brings significant improvements to SSH with a new connections configuration system for managing your remote environments.

- **Workspaces**: Organize your work into separate environments, each with their own tabs, layouts, and settings
- **Command Blocks**: New `wsh run` command for launching terminal commands in dedicated blocks, with support for magnification, auto-closing, and execution control ([docs](/wsh#run))
- **Command Blocks**: New `wsh run` command for launching terminal commands in dedicated blocks, with support for magnification, auto-closing, and execution control ([docs](/wsh-reference#run))
- **Connections**: New configuration system for managing SSH connections, with support for wsh-free operation, per-connection themes, and more ([docs](/connections))
- Improved tab management with better switching behavior and context menus (many bug fixes)
- New tab features including pinned tabs and drag-and-drop improvements
- Create, rename, and delete files/directories directly in directory preview
- Attempt wsh-free connection as a fallback if wsh installation or execution fails
- New `-i` flag to add identity files with the `wsh ssh` command
- Added Perplexity API integration ([docs](/faq#perplexity))
- `wsh setbg` command for background handling ([docs](/wsh#setbg))
- `wsh setbg` command for background handling ([docs](/wsh-reference#setbg))
- Switched from Less to SCSS for styling
- [bugfix] Fixed tab flickering issues during tab switches
- [bugfix] Corrected WaveAI text area resize behavior
Expand All @@ -32,8 +32,8 @@ Wave Terminal v0.10.0 introduces workspaces, making it easier to manage multiple

New minor release that introduces Wave's connected computing extensions. We've introduced new `wsh` commands that allow you to store variables and files, and access them across terminal sessions (on both local and remote machines).

- `wsh setvar/getvar` to get and set variables -- [Docs](https://docs.waveterm.dev/wsh#getvarsetvar)
- `wsh file` operations (cat, write, append, rm, info, cp, and ls) -- [Docs](https://docs.waveterm.dev/wsh#file)
- `wsh setvar/getvar` to get and set variables -- [Docs](https://docs.waveterm.dev/wsh-reference#getvarsetvar)
- `wsh file` operations (cat, write, append, rm, info, cp, and ls) -- [Docs](https://docs.waveterm.dev/wsh-reference#file)
- Improved golang panic handling to prevent backend crashes
- Improved SSH config logging and fixes a reused connection bug
- Updated telemetry to track additional counters
Expand Down
Loading