mirror of
https://github.com/wavetermdev/waveterm
synced 2026-05-06 06:58:21 +00:00
An open-source, AI-integrated, cross-platform terminal for seamless workflows
17fb1567e9
## Background & Motivation After installing Wave Terminal, new tabs and splits always started in my home folder instead of the current project directory, contrary to expectations from other terminals I've used. For context, I use `bash` for my shell. The existing documentation did not provide guidance about the required OSC 7 setup, so I had to dig into GitHub issues and source code to discover that Wave relies on a terminal escape sequence to track the shell’s working directory. This confusion represents a barrier for first-time users. ## Description This PR introduces a new documentation page—**Tracking Your Shell’s Working Directory**—which: 1. Explains **why** Wave uses the OSC 7 escape sequence to keep its internal `cmd:cwd` metadata in sync with your shell. 2. Provides copy-and-paste snippets to **enable** OSC 7 in **Bash**, **Zsh**, and **Fish**. 3. Details **verification steps** in the Wave UI to confirm correct CWD tracking. By making this enhancement, users can: - Open new tabs or split panes with their current working directory. - Avoid the `ERRCWD invalid cwd` errors in some shell configurations. - Spend less time troubleshooting and more time working. ## Changes - **Added** `docs/docs/track-cwd.mdx` (new page to enable OSC 7). - **Updated** `docs/docs/index.mdx` (linked the new page under **Other References**). ## Related Issues - <https://github.com/wavetermdev/waveterm/issues/1130> — New tabs should inherit the CWD. - <https://github.com/wavetermdev/waveterm/issues/2057> — Split panes always start in home directory. ## Testing & Review 1. **Local build** ```bash cd waveterm yarn task docsite ``` - Confirm the new “Tracking Your Shell’s Working Directory” page appears in the sidebar. - Verify the instructions and code samples render correctly. 2. **Content review** - Are the shell snippets accurate? - Is the enable → verify flow clear and complete? --- _I have followed the [contributing guidelines](https://github.com/wavetermdev/waveterm/blob/main/CONTRIBUTING.md) and used a conventional commit message._ |
||
|---|---|---|
| .github | ||
| .storybook | ||
| .vscode | ||
| .zed | ||
| aiprompts | ||
| assets | ||
| build | ||
| cmd | ||
| db | ||
| docs | ||
| emain | ||
| frontend | ||
| pkg | ||
| public | ||
| schema | ||
| testdriver | ||
| tests/copytests | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .prettierignore | ||
| .yarnrc.yml | ||
| ACKNOWLEDGEMENTS.md | ||
| BUILD.md | ||
| CNAME | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| electron-builder.config.cjs | ||
| electron.vite.config.ts | ||
| eslint.config.js | ||
| go.mod | ||
| go.sum | ||
| index.html | ||
| LICENSE | ||
| NOTICE | ||
| package.json | ||
| prettier.config.cjs | ||
| README.md | ||
| RELEASES.md | ||
| ROADMAP.md | ||
| SECURITY.md | ||
| Taskfile.yml | ||
| tsconfig.json | ||
| version.cjs | ||
| vitest.config.ts | ||
| yarn.lock | ||
Wave Terminal
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.
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.
Key Features
- Flexible drag & drop interface to organize terminal blocks, editors, web browsers, and AI assistants
- Built-in editor for seamlessly editing remote files with syntax highlighting and modern editor features
- Rich file preview system for remote files (markdown, images, video, PDFs, CSVs, directories)
- Integrated AI chat with support for multiple models (OpenAI, Claude, Azure, Perplexity, Ollama)
- Command Blocks for isolating and monitoring individual commands with auto-close options
- One-click remote connections with full terminal and file system access
- Rich customization including tab themes, terminal styles, and background images
- Powerful
wshcommand system for managing your workspace from the CLI and sharing data between terminal sessions
Installation
Wave Terminal works on macOS, Linux, and Windows.
Platform-specific installation instructions can be found here.
You can also install Wave Terminal directly from: www.waveterm.dev/download.
Minimum requirements
Wave Terminal runs on the following platforms:
- macOS 11 or later (arm64, x64)
- Windows 10 1809 or later (x64)
- Linux based on glibc-2.28 or later (Debian 10, RHEL 8, Ubuntu 20.04, etc.) (arm64, x64)
The WSH helper runs on the following platforms:
- macOS 11 or later (arm64, x64)
- Windows 10 or later (arm64, x64)
- Linux Kernel 2.6.32 or later (x64), Linux Kernel 3.1 or later (arm64)
Roadmap
Wave is constantly improving! Our roadmap will be continuously updated with our goals for each release. You can find it here.
Want to provide input to our future releases? Connect with us on Discord or open a Feature Request!
Links
- Homepage — https://www.waveterm.dev
- Download Page — https://www.waveterm.dev/download
- Documentation — https://docs.waveterm.dev
- Legacy Documentation — https://legacydocs.waveterm.dev
- Blog — https://blog.waveterm.dev
- X — https://x.com/wavetermdev
- Discord Community — https://discord.gg/XfvZ334gwU
Building from Source
Contributing
Wave uses GitHub Issues for issue tracking.
Find more information in our Contributions Guide, which includes:
License
Wave Terminal is licensed under the Apache-2.0 License. For more information on our dependencies, see here.