waveterm README

The project's README from github.com/wavetermdev/waveterm. As one markdown file: README.md.

Wave Terminal Logo

Wave Terminal

English | 한국어 | 繁體中文

FOSSA Status

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.

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.

WaveTerm Screenshot

Key Features

Wave AI

Wave AI is your context-aware terminal assistant with access to your workspace:

Learn more in our Wave AI documentation and Wave AI Modes documentation.

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:

The WSH helper runs on the following platforms:

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!

Building from Source

See Building Wave Terminal.

Contributing

Wave uses GitHub Issues for issue tracking.

Find more information in our Contributions Guide, which includes:

Sponsoring Wave ❤️

If Wave Terminal is useful to you or your company, consider sponsoring development.

Sponsorship helps support the time spent building and maintaining the project.

License

Wave Terminal is licensed under the Apache-2.0 License. For more information on our dependencies, see here.

waveterm (wavetermdev/waveterm)

ai-assistant
Searching Database…

22.5K ·GitHub
What is this?Wave is an open-source, AI-integrated terminal for macOS, Linux, and Windows. It bundles a context-aware AI assistant, durable SSH sessions, and a block-based workspace with editors and file previews.
Is this a plain terminal emulator or a full desktop app?It is a full desktop GUI app: terminals, editors, web browsers, and AI assistants sit in drag-and-drop blocks. Under the hood it is an Electron app with a Go backend.
Do I need an account or API keys for the AI features?No accounts are required. You bring your own API keys for OpenAI, Claude, or Gemini, or run local models through Ollama, LM Studio, or other OpenAI-compatible providers.
What can't the AI assistant do yet?It cannot run commands yet — command execution with user approval is listed as coming soon. The AI experience is also still a free beta.
Where are my API keys and credentials stored?Keys and credentials are stored locally using your OS-native secret storage backends and stay accessible across SSH sessions.
Is Wave free to use?Wave is free and open source under Apache-2.0. The AI side is a free beta that includes some AI credits while the experience is being refined.
What can Wave AI actually do inside the terminal?It reads your terminal output and scrollback for debugging and analysis, reads, writes, and edits files with automatic backups and user approval, and works from the CLI via wsh ai, which pipes output or attaches files to a chat.
How does it handle files on remote machines?A built-in graphical editor with syntax highlighting edits remote files, and inline previews cover markdown, images, video, PDFs, CSVs, and directories. The wsh file command copies and syncs files between local and remote SSH hosts.
Can I change how the terminal looks?Yes — customization covers tab themes, terminal styles, and background images, and any block can be toggled to full screen and back to the multi-block view.
What are similar projects?surf, aichat, get-it, Netcatty, Fabric, open-codesign, quivr, zuse
Size
57.7 MB
Stars
22.5K
Age
4y
Commits · 90 Days