waveterm/README.md
Evan Simkowitz edb3290349
Move docsite to main repo (#1204)
## Summary

We are moving our docsite to this repo for better coordination.

## What's changed?

- The docsite codebase is now in docs/
- The docsite will replace storybook as the published GitHub Pages site
for this repo
- Storybook will now be hosted at https://docs.waveterm.dev/storybook
- A new CI workflow will validate any changes to Storybook or the
docsite
- A combined CD workflow will build and deploy Storybook and the docsite
as a single artifact
- The Build Helper workflow will now build an embedded version of the
docsite before building the app, ensuring the docsite version it has is
always the latest
2024-11-06 10:45:21 -08:00

2.9 KiB

Wave Terminal Logo

Wave Terminal

FOSSA Status

Wave is an open-source terminal that can launch graphical widgets, controlled and integrated directly with the CLI. It includes a base terminal, directory browser, file previews (images, media, markdown), a graphical editor (for code/text files), a web browser, and integrated AI chat.

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.

WaveTerm Screenshot

Installation

Wave Terminal works on macOS, Linux, and Windows.

Install Wave Terminal from: www.waveterm.dev/download

Also available as a Homebrew Cask for macOS:

brew install --cask wave

Also available as a Snap on Linux:

sudo snap install waveterm --classic

Also available via the Windows Package Manager:

winget install CommandLine.Wave

Minimum requirements

Wave Terminal and WSH run on the following platforms:

  • macOS 10.15 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)

Building from Source

See Building Wave Terminal.

Contributing

Wave uses GitHub Issues for issue tracking.

Find more information in our Contributions Guide, which includes:

Activity

Alt

License

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