waveterm/README.md

56 lines
2.0 KiB
Markdown
Raw Normal View History

<p align="center">
<picture>
2023-10-31 18:42:04 +01:00
<source media="(prefers-color-scheme: dark)" srcset="./src/app/assets/wave-logo_horizontal-coloronblack.svg">
<source media="(prefers-color-scheme: light)" srcset="./src/app/assets/wave-logo_horizontal-coloronwhite.svg">
<img alt="Wave Terminal Logo" src="./src/app/assets/wave-logo_horizontal-coloronwhite.svg" width="352" height="59" style="max-width: 100%;">
</picture>
<br/>
</p>
# Wave Terminal
2023-11-07 09:40:21 +01:00
A open-source, cross-platform, modern terminal for seamless workflows.
2023-11-07 09:40:21 +01:00
Wave isn't just another terminal emulator; it's a rethink on how terminals are built. Wave combines command line with the power of the open web to help veteran CLI users and new developers alike.
2023-11-07 09:40:21 +01:00
* Inline renderers to cut down on context switching. Render code, images, markdown, and CSV files without ever leaving the terminal.
* Persistent sessions that can restore state across network disconnections and reboots
* Searchable contextual command history across all remote sessions (saved locally)
* Workspaces, tabs, and command blocks to keep you organized
## Installation
Wave Terminal works with MacOS and Linux (preliminary).
Install Wave Terminal from: [www.waveterm.dev/download](https://www.waveterm.dev/download)
2023-12-10 22:33:06 +01:00
Also available as a homebrew cask for MacOS:
```
brew install --cask wave
```
2023-11-07 09:40:21 +01:00
## Links
* Homepage &mdash; https://www.waveterm.dev
* Download Page &mdash; https://www.waveterm.dev/download
* Documentation &mdash; https://docs.waveterm.dev/
* Quick Start Guide &mdash; https://docs.waveterm.dev/quickstart/
2023-11-07 09:40:21 +01:00
* Discord Community &mdash; https://discord.gg/XfvZ334gwU
2023-11-07 09:49:37 +01:00
## Building from Source
* [MacOS Build Instructions](./BUILD.md)
* [Linux Build Instructions](./build-linux.md)
## Contributing
Wave uses Github Project for tracking issues.
2023-10-31 18:42:04 +01:00
Find more information in our [Contributions Guide](CONTRIBUTING.md), which includes:
2023-10-31 18:42:04 +01:00
* [Ways to contribute](CONTRIBUTING.md#contributing-to-wave-terminal)
* [Contribution guidelines](CONTRIBUTING.md#before-you-start)