waveterm/README.md

66 lines
2.6 KiB
Markdown
Raw Normal View History

2024-09-18 21:45:14 +02:00
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="./assets/waveterm-logo-horizontal-dark.png">
<source media="(prefers-color-scheme: light)" srcset="./assets/waveterm-logo-horizontal-light.png">
<img alt="Wave Terminal Logo" src="./assets/waveterm-logo-horizontal-light.png" width="240" height="80" style="max-width: 100%;">
</picture>
<br/>
</p>
2024-05-10 05:38:54 +02:00
2024-09-18 21:45:14 +02:00
# Wave Terminal
2024-05-10 05:38:54 +02:00
2024-09-18 21:45:14 +02:00
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fwavetermdev%2Fwaveterm.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fwavetermdev%2Fwaveterm?ref=badge_shield)
2024-05-10 05:38:54 +02:00
2024-09-18 21:45:14 +02:00
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](./assets/wave-screenshot.png)
## 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:
```
brew install --cask wave
2024-05-10 05:38:54 +02:00
```
2024-09-18 21:45:14 +02:00
## Links
2024-05-10 05:38:54 +02:00
2024-09-18 21:45:14 +02:00
- Homepage &mdash; https://www.waveterm.dev
- Download Page &mdash; https://www.waveterm.dev/download
- Documentation &mdash; https://docs.waveterm.dev/
- Blog &mdash; https://blog.waveterm.dev/
- Discord Community &mdash; https://discord.gg/XfvZ334gwU
## Building from Source
We use `task` to build Wave.
```bash
brew install go-task
2024-05-10 05:38:54 +02:00
```
2024-09-18 21:45:14 +02:00
Once task is installed you can run this command to build and launch the development version of Wave. Note that the development database and settings are kept in a separate folder from the production version (~/.waveterm-dev) to prevent cross-corruption.
2024-05-10 05:38:54 +02:00
2024-09-18 21:45:14 +02:00
```bash
task electron:dev
2024-05-10 05:38:54 +02:00
```
2024-09-18 21:45:14 +02:00
## Contributing
2024-05-10 05:38:54 +02:00
2024-09-18 21:45:14 +02:00
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)
## License
Wave Terminal is licensed under the Apache-2.0 License. For more information on our dependencies, see [here](./acknowledgements/README.md).