diff --git a/features/appearance.mdx b/features/appearance.mdx index 58fde6c..e3c8b0b 100644 --- a/features/appearance.mdx +++ b/features/appearance.mdx @@ -4,6 +4,12 @@ description: 'Wave lets you customize the look and feel of your terminal' icon: 'paintbrush' --- + +## Wave Terminal Documentation Has Moved + +As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev). + + diff --git a/features/codeedit.mdx b/features/codeedit.mdx index 5ad2c44..131ec1c 100644 --- a/features/codeedit.mdx +++ b/features/codeedit.mdx @@ -4,6 +4,12 @@ description: 'Edit files inline and quickly using a rich native UI' icon: 'code' --- + +## Wave Terminal Documentation Has Moved + +As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev). + + Codeedit is built using [Monaco](https://microsoft.github.io/monaco-editor/) (the editor that powers VS Code) and allows you to view and edit files inline using a rich, native UI. It brings to your terminal an unparalleled editing experience with features such as syntax highlighting, code folding, code completion, find and replace, and much more. diff --git a/features/connections.mdx b/features/connections.mdx index 0df6fdd..a2bea5f 100644 --- a/features/connections.mdx +++ b/features/connections.mdx @@ -3,6 +3,13 @@ title: 'Connections' description: 'Run commands on remote machines' icon: 'map' --- + + +## Wave Terminal Documentation Has Moved + +As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev). + + ## Connections Wave enhances SSH by offering connections that stay alive across sessions, maintaining your environment and history, unlike traditional SSH that might disconnect and lacks universal command history. Setting up a Wave connection creates a resilient virtual SSH connection, preserving your session details and command logs. diff --git a/features/fileViewers.mdx b/features/fileViewers.mdx index 11e9f96..7cd0e37 100644 --- a/features/fileViewers.mdx +++ b/features/fileViewers.mdx @@ -4,6 +4,12 @@ description: 'View various file types directly in the terminal' icon: 'file-magnifying-glass' --- + +## Wave Terminal Documentation Has Moved + +As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev). + + ## What Are File Viewer Plugins? File viewer plugins are file integrations that allow you to render various file types inline, directly within the terminal. These plugins provide a convenient way to view and interact with different file formats without the need to switch to external applications. diff --git a/features/history.mdx b/features/history.mdx index 90fedc3..56b2b96 100644 --- a/features/history.mdx +++ b/features/history.mdx @@ -4,6 +4,12 @@ description: 'Make the most of persistent, context rich history' icon: 'scroll' --- + +## Wave Terminal Documentation Has Moved + +As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev). + + ## Introduction Navigating your command history efficiently is crucial for productivity in any terminal environment. Wave's advanced history features allow you to seamlessly access and manage your past commands not just within the current session but across all workspaces and devices. diff --git a/features/markdown.mdx b/features/markdown.mdx index 73a3d4b..6b2a9cd 100644 --- a/features/markdown.mdx +++ b/features/markdown.mdx @@ -4,6 +4,12 @@ description: 'Edit markdown directly in your terminal' icon: 'text-size' --- + +## Wave Terminal Documentation Has Moved + +As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev). + + Quickly edit code on a local or remote machine with the `codeedit` command ### Example diff --git a/features/sshconfig-imports.mdx b/features/sshconfig-imports.mdx index 4584ccf..4dd6e19 100644 --- a/features/sshconfig-imports.mdx +++ b/features/sshconfig-imports.mdx @@ -4,6 +4,12 @@ description: 'Import your local SSH Configuration' icon: 'file-import' --- + +## Wave Terminal Documentation Has Moved + +As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev). + + ## How To Use You have the ability to import your SSH Configuration in two ways. - The `remote:parse` command which takes no arguments diff --git a/features/supportedLLMs/generic.mdx b/features/supportedLLMs/generic.mdx index fe10010..56840fd 100644 --- a/features/supportedLLMs/generic.mdx +++ b/features/supportedLLMs/generic.mdx @@ -3,6 +3,12 @@ title: 'Generic (Bring Your Own)' description: 'Get up and running with your own LLM provider' --- + +## Wave Terminal Documentation Has Moved + +As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev). + + Wave AI supports the integration of any LLM provider that uses the [OpenAI Chat Completions API](https://platform.openai.com/docs/api-reference/chat). This feature allows you to bring your own compatible LLM provider and seamlessly integrate it into your workflow. While we strive to test and include as many LLM providers as possible, we simply cannot add them all. This is where the ability to add your own, custom LLM comes in — it allows you to configure your own LLM provider with just a couple of simple changes, even if it's not officially listed as supported by Wave AI. diff --git a/features/supportedLLMs/llamacpp.mdx b/features/supportedLLMs/llamacpp.mdx index be37c62..2644cef 100644 --- a/features/supportedLLMs/llamacpp.mdx +++ b/features/supportedLLMs/llamacpp.mdx @@ -3,6 +3,12 @@ title: 'llama.cpp' description: 'Get llama.cpp up and running in Wave AI' --- + +## Wave Terminal Documentation Has Moved + +As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev). + + [llama.cpp](https://github.com/ggerganov/llama.cpp) is an open-source project that enables efficient inference of Meta's LLaMA and other compatible models using pure C/C++, with the main goal of enabling LLM inference with minimal setup and state-of-the-art performance on a wide variety of hardware. It offers optimizations for various architectures, supports integer quantization for faster inference and reduced memory usage, and includes custom CUDA kernels, Vulkan, SYCL, and OpenCL backend support. Wave specifically supports the [llama.cpp HTTP Server](https://github.com/ggerganov/llama.cpp/tree/master/examples/server#llamacpp-http-server), which makes the models available locally to run from other applications like Wave. diff --git a/features/supportedLLMs/lmstudio.mdx b/features/supportedLLMs/lmstudio.mdx index bb677b9..9d921e1 100644 --- a/features/supportedLLMs/lmstudio.mdx +++ b/features/supportedLLMs/lmstudio.mdx @@ -3,6 +3,12 @@ title: 'LM Studio' description: 'Get LM Studio up and running in Wave AI' --- + +## Wave Terminal Documentation Has Moved + +As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev). + + [LM Studio](https://lmstudio.ai/) is a desktop application that allows users to discover, download, and run Large Language Models (LLMs) offline on their personal computers. It supports ggml-compatible models from Hugging Face, including Llama, MPT, and StarCoder. LM Studio provides a user-friendly Chat UI for engaging with the models and an OpenAI-compatible local server for seamless integration with other tools and applications. Wave specifically supports the [LM Studio Server](https://lmstudio.ai/docs/local-server), which makes the models available locally to run from other applications like Wave. diff --git a/features/supportedLLMs/localai.mdx b/features/supportedLLMs/localai.mdx index ef755e7..dfa9968 100644 --- a/features/supportedLLMs/localai.mdx +++ b/features/supportedLLMs/localai.mdx @@ -3,6 +3,12 @@ title: 'LocalAI' description: 'Get LocalAI up and running in Wave AI' --- + +## Wave Terminal Documentation Has Moved + +As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev). + + [LocalAI](https://localai.io/) is a free, open-source alternative to OpenAI that allows users to run large language models (LLMs), generate images, audio, and more locally or on-premises using consumer-grade hardware. It acts as a drop-in replacement REST API compatible with OpenAI API specifications, enabling users to perform local inferencing. LocalAI supports multiple model families and architectures without requiring a GPU, giving users the power and flexibility to leverage AI while maintaining full control over their data and infrastructure. **Note:** At the moment, Wave's integration with LocalAI only supports their LLM features. Image generation, audio processing, speech to text, and other capabilities are not yet available but may be added in future updates. diff --git a/features/supportedLLMs/ollama.mdx b/features/supportedLLMs/ollama.mdx index 27ce29b..5b34022 100644 --- a/features/supportedLLMs/ollama.mdx +++ b/features/supportedLLMs/ollama.mdx @@ -3,6 +3,12 @@ title: 'Ollama' description: 'Get Ollama up and running in Wave AI' --- + +## Wave Terminal Documentation Has Moved + +As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev). + + [Ollama](https://ollama.com/) is an open-source language model that offers a powerful and flexible alternative to proprietary LLMs, allowing you to run the model locally or on your own server infrastructure. Ollama provides high-quality language generation and understanding capabilities while giving you full control over your data and privacy. diff --git a/features/supportedLLMs/openai.mdx b/features/supportedLLMs/openai.mdx index 7c4e36a..91646fb 100644 --- a/features/supportedLLMs/openai.mdx +++ b/features/supportedLLMs/openai.mdx @@ -3,6 +3,12 @@ title: 'OpenAI' description: 'Get up and running with a different model in OpenAI' --- + +## Wave Terminal Documentation Has Moved + +As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev). + + By default, Wave AI proxies your requests through our cloud servers to OpenAI using the _gpt-3.5-turbo_ model. However, users can use their own _API key_ and _model_ for additional flexibility, privacy, and to bypass our current rate limit of 200 requests per day to OpenAI, which was implemented to prevent abuse. diff --git a/features/waveAI.mdx b/features/waveAI.mdx index 8b279bb..9fde804 100644 --- a/features/waveAI.mdx +++ b/features/waveAI.mdx @@ -4,6 +4,12 @@ description: 'Talk to ChatGPT in the terminal' icon: 'robot' --- + +## Wave Terminal Documentation Has Moved + +As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev). + + Wave AI is our native ChatGPT integration that allows you to ask questions and receive answers directly from your terminal. This feature streamlines your workflow by providing AI assistance without the need to switch between multiple tools or applications. Wave AI also supports the use of third party LLM providers, allowing you to tailor your AI experience to your specific needs and concerns, whether they're related to privacy, ethics, or accessing the latest technologies. See the [Third-Party LLM Support](#third-party-llm-support-byollm) section for a full list of supported LLM providers. diff --git a/introduction.mdx b/introduction.mdx index 8a1d0f9..9047e14 100644 --- a/introduction.mdx +++ b/introduction.mdx @@ -3,7 +3,11 @@ title: Introduction description: 'Welcome to the legacy version of Wave Terminal' --- -As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version, check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev). + +## Wave Terminal Documentation Has Moved + +As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev). + +## Wave Terminal Documentation Has Moved + +As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev). + + ## Installation diff --git a/reference/customKeybindings.mdx b/reference/customKeybindings.mdx index 5bf84d0..9a20ab0 100644 --- a/reference/customKeybindings.mdx +++ b/reference/customKeybindings.mdx @@ -1,6 +1,13 @@ --- title: Custom Keybindings --- + + +## Wave Terminal Documentation Has Moved + +As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev). + + Custom keybindings in Wave allow you to personalize and streamline your workflow by creating shortcuts tailored to your preferences and needs. By customizing keybindings, you can execute commands, trigger actions, and navigate within the Wave terminal more efficiently. ## Basics diff --git a/reference/faq.mdx b/reference/faq.mdx index 7afe0d3..6330cc2 100644 --- a/reference/faq.mdx +++ b/reference/faq.mdx @@ -2,6 +2,12 @@ title: FAQ --- + +## Wave Terminal Documentation Has Moved + +As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev). + + ## Where is my data stored? All of your data, including command history, environment data, and output and all metadata is stored *locally* on your machine in the `~/.waveterm` directory. None of that information ever leaves your machine. In the future we may launch cloud features to support terminal sharing, shared workspaces, shared playbooks, and terminal backup/sync. These will *opt-in*. We'll never release an update that moves your *private* data off your machine without your explicit consent. diff --git a/reference/keyboard.mdx b/reference/keyboard.mdx index 58d925b..3975027 100644 --- a/reference/keyboard.mdx +++ b/reference/keyboard.mdx @@ -2,6 +2,12 @@ title: Keyboard Shortcuts --- + +## Wave Terminal Documentation Has Moved + +As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev). + + Most of Wave's global keyboard shortcuts use Cmd/Alt because we generally try to reserve the Ctrl key for interacting with terminal commands directly or for system shortcuts like Copy, Paste, Select All, etc. The shortcuts listed in the chart below are for MacOS. Linux/Windows keybindings use `Alt` in place of `Cmd`. diff --git a/reference/slashcommands.mdx b/reference/slashcommands.mdx index 5ca73c4..c4f1bb2 100644 --- a/reference/slashcommands.mdx +++ b/reference/slashcommands.mdx @@ -2,6 +2,12 @@ title: SlashCommand Reference --- + +## Wave Terminal Documentation Has Moved + +As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev). + + Welcome to our Slash Command Reference Guide, a comprehensive resource designed to streamline your workflow in Wave using intuitive commands. Here, you'll find detailed explanations on how to manage various settings and configurations in Wave related to sessions and windows, client settings, editing and viewing files inline, and much more. diff --git a/reference/telemetry.mdx b/reference/telemetry.mdx index a4f6462..fd47bb8 100644 --- a/reference/telemetry.mdx +++ b/reference/telemetry.mdx @@ -3,6 +3,12 @@ title: Telemetry description: As of v0.7.5 --- + +## Wave Terminal Documentation Has Moved + +As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev). + + Wave Terminal collects telemetry data to help us track feature use, direct future product efforts, and generate aggregate metrics on Wave's popularity and usage. We do not collect or store any PII (personal identifiable information) and all metric data is only associated with and aggregated using your randomly generated _ClientId_. You may opt out of collection at any time. If you would like to turn telemetry on or off, the first opportunity is a button on the initial welcome page. After this, you can find a similar button by opening the settings menu (located at the bottom of the left sidebar). It can alternatively be turned on with the `/telemetry:on` command and turned off with the `/telemetry:off` command. diff --git a/reference/waveshell.mdx b/reference/waveshell.mdx index be378dd..4e65e38 100644 --- a/reference/waveshell.mdx +++ b/reference/waveshell.mdx @@ -2,6 +2,12 @@ title: WaveShell Helper --- + +## Wave Terminal Documentation Has Moved + +As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev). + + WaveShell (also known as MShell) is a small open-source helper program that facilitates advanced communication between your local Wave Terminal instance and a remote machine. It enables Wave Terminal to provide advanced terminal features like command blocks, persistent sessions, and detailed universal command history. Note that waveshell is does *not* communicate with any external services, does not open any ports, and does *not* send any information or telemetry to Wave Terminal or Command Line Inc servers. It communicates exclusively with the local Wave Terminal running on your machine via a standard SSH connection over stdin/stdout. It does not require or try to acquire any additional privledges on the remote computer (unless of course you explicitly request it run with sudo privledges to execute sudo commands). It is run only when Wave Terminal establishes a connection to the remote machine, and does not stay resident (as a daemon) when the connection is not active. diff --git a/releasenotes.mdx b/releasenotes.mdx index f1eb181..8495529 100644 --- a/releasenotes.mdx +++ b/releasenotes.mdx @@ -2,6 +2,12 @@ title: Release Notes --- + +## Wave Terminal Documentation Has Moved + +As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev). + + Download the latest legacy build here: https://www.waveterm.dev/download-legacy ### v0.7.7 - 09/20/2024