mirror of
https://github.com/wavetermdev/waveterm.git
synced 2024-12-22 16:48:23 +01:00
edb3290349
## 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
82 lines
2.9 KiB
Markdown
82 lines
2.9 KiB
Markdown
<p align="center">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="./assets/wave-dark.png">
|
|
<source media="(prefers-color-scheme: light)" srcset="./assets/wave-light.png">
|
|
<img alt="Wave Terminal Logo" src="./assets/wave-light.png" width="240">
|
|
</picture>
|
|
<br/>
|
|
</p>
|
|
|
|
# Wave Terminal
|
|
|
|
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fwavetermdev%2Fwaveterm?ref=badge_shield)
|
|
|
|
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.
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
Wave Terminal works on macOS, Linux, and Windows.
|
|
|
|
Install Wave Terminal from: [www.waveterm.dev/download](https://www.waveterm.dev/download)
|
|
|
|
Also available as a Homebrew Cask for macOS:
|
|
|
|
```bash
|
|
brew install --cask wave
|
|
```
|
|
|
|
Also available as a [Snap](https://snapcraft.io/waveterm) on Linux:
|
|
|
|
```bash
|
|
sudo snap install waveterm --classic
|
|
```
|
|
|
|
Also available via the Windows Package Manager:
|
|
|
|
```Powershell
|
|
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)
|
|
|
|
## 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
|
|
- Discord Community — https://discord.gg/XfvZ334gwU
|
|
|
|
## Building from Source
|
|
|
|
See [Building Wave Terminal](BUILD.md).
|
|
|
|
## Contributing
|
|
|
|
Wave uses GitHub Issues for issue tracking.
|
|
|
|
Find more information in our [Contributions Guide](CONTRIBUTING.md), which includes:
|
|
|
|
- [Ways to contribute](CONTRIBUTING.md#contributing-to-wave-terminal)
|
|
- [Contribution guidelines](CONTRIBUTING.md#before-you-start)
|
|
- [Storybook](https://docs.waveterm.dev/storybook)
|
|
|
|
### Activity
|
|
|
|
|
|
|
|
## License
|
|
|
|
Wave Terminal is licensed under the Apache-2.0 License. For more information on our dependencies, see [here](./ACKNOWLEDGEMENTS.md).
|