Skip to content

Commit c7a5c8b

Browse files
authored
readme updates for durable sessions / wave ai (#2886)
readme hasn't been updated in a while and was out of date. update the hero text, wave ai section, and add durable sessions.
1 parent 337b010 commit c7a5c8b

1 file changed

Lines changed: 12 additions & 11 deletions

File tree

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,26 +13,27 @@
1313

1414
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fwavetermdev%2Fwaveterm.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fwavetermdev%2Fwaveterm?ref=badge_shield)
1515

16-
Wave is an open-source terminal that combines traditional terminal features with graphical capabilities like file previews, web browsing, and AI assistance. It runs on MacOS, Linux, and Windows.
16+
Wave is an open-source, AI-integrated terminal for macOS, Linux, and Windows. It works with any AI model. Bring your own API keys for OpenAI, Claude, or Gemini, or run local models via Ollama and LM Studio. No accounts required.
1717

18-
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.
18+
Wave also supports durable SSH sessions that survive network interruptions and restarts, with automatic reconnection. Edit remote files with a built-in graphical editor and preview files inline without leaving the terminal.
1919

2020
![WaveTerm Screenshot](./assets/wave-screenshot.webp)
2121

2222
## Key Features
2323

24+
- Wave AI - Context-aware terminal assistant that reads your terminal output, analyzes widgets, and performs file operations
25+
- Durable SSH Sessions - Remote terminal sessions survive connection interruptions, network changes, and Wave restarts with automatic reconnection
2426
- Flexible drag & drop interface to organize terminal blocks, editors, web browsers, and AI assistants
25-
- Built-in editor for seamlessly editing remote files with syntax highlighting and modern editor features
27+
- Built-in editor for editing remote files with syntax highlighting and modern editor features
2628
- Rich file preview system for remote files (markdown, images, video, PDFs, CSVs, directories)
2729
- Quick full-screen toggle for any block - expand terminals, editors, and previews for better visibility, then instantly return to multi-block view
28-
- Wave AI - Context-aware terminal assistant that reads your terminal output, analyzes widgets, and performs file operations
2930
- AI chat widget with support for multiple models (OpenAI, Claude, Azure, Perplexity, Ollama)
30-
- Command Blocks for isolating and monitoring individual commands with auto-close options
31+
- Command Blocks for isolating and monitoring individual commands
3132
- One-click remote connections with full terminal and file system access
3233
- Secure secret storage using native system backends - store API keys and credentials locally, access them across SSH sessions
3334
- Rich customization including tab themes, terminal styles, and background images
3435
- Powerful `wsh` command system for managing your workspace from the CLI and sharing data between terminal sessions
35-
- Connected file management with `wsh file` - seamlessly copy and sync files between local, remote SSH hosts, Wave filesystem, and S3
36+
- Connected file management with `wsh file` - seamlessly copy and sync files between local and remote SSH hosts
3637

3738
## Wave AI
3839

@@ -41,10 +42,12 @@ Wave AI is your context-aware terminal assistant with access to your workspace:
4142
- **Terminal Context**: Reads terminal output and scrollback for debugging and analysis
4243
- **File Operations**: Read, write, and edit files with automatic backups and user approval
4344
- **CLI Integration**: Use `wsh ai` to pipe output or attach files directly from the command line
45+
- **BYOK Support**: Bring your own API keys for OpenAI, Claude, Gemini, Azure, and other providers
46+
- **Local Models**: Run local models with Ollama, LM Studio, and other OpenAI-compatible providers
4447
- **Free Beta**: Included AI credits while we refine the experience
45-
- **Coming Soon**: Command execution (with approval), local model support, and alternate AI providers (BYOK)
48+
- **Coming Soon**: Command execution (with approval)
4649

47-
Learn more in our [Wave AI documentation](https://docs.waveterm.dev/waveai).
50+
Learn more in our [Wave AI documentation](https://docs.waveterm.dev/waveai) and [Wave AI Modes documentation](https://docs.waveterm.dev/waveai-modes).
4851

4952
## Installation
5053

@@ -65,7 +68,7 @@ Wave Terminal runs on the following platforms:
6568
The WSH helper runs on the following platforms:
6669

6770
- macOS 11 or later (arm64, x64)
68-
- Windows 10 or later (arm64, x64)
71+
- Windows 10 or later (x64)
6972
- Linux Kernel 2.6.32 or later (x64), Linux Kernel 3.1 or later (arm64)
7073

7174
## Roadmap
@@ -79,8 +82,6 @@ Want to provide input to our future releases? Connect with us on [Discord](https
7982
- Homepage — https://www.waveterm.dev
8083
- Download Page — https://www.waveterm.dev/download
8184
- Documentation — https://docs.waveterm.dev
82-
- Legacy Documentation — https://legacydocs.waveterm.dev
83-
- Blog — https://blog.waveterm.dev
8485
- X — https://x.com/wavetermdev
8586
- Discord Community — https://discord.gg/XfvZ334gwU
8687

0 commit comments

Comments
 (0)