You've already forked waveterm-docs-old
mirror of
https://github.com/wavetermdev/waveterm-docs-old.git
synced 2026-04-22 15:22:42 -07:00
added waveAI page
This commit is contained in:
Knox Lively
@@ -1,27 +0,0 @@
|
||||
---
|
||||
title: 'ChatGPT Support'
|
||||
description: 'Talk to ChatGPT in the terminal'
|
||||
icon: 'robot'
|
||||
---
|
||||
|
||||
You can use the `chat` command to query AI chat models inside Wave terminal.
|
||||
|
||||
Usage
|
||||
```
|
||||
/chat tell me how to use the sed command
|
||||
```
|
||||
|
||||
Out of the box, this command will send a request through our cloud servers.
|
||||
If you'd prefer to query the OpenAI API directly, you can specify your own OpenAI key, as well as the model
|
||||
that you would like to use in the settings.
|
||||
|
||||
We also have support for changing the API base url if you want to use Azure models or other 3rd party API's.
|
||||
You can set the base url with the client:set command, like so:
|
||||
|
||||
```
|
||||
/client:set openaibaseurl="<BASE URL>"
|
||||
```
|
||||
The API you specify must have the same endpoints and same protocol as the OpenAI API.
|
||||
|
||||
In order to prevent abuse, you must have telemetry enabled to use the cloud servers. There is currently a rate limit of 200 requests per day.
|
||||
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
title: 'Wave AI'
|
||||
description: 'Talk to ChatGPT in the terminal'
|
||||
icon: 'robot'
|
||||
---
|
||||
|
||||
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.
|
||||
|
||||
## Using Wave AI
|
||||
|
||||
There are currently two ways to use Wave AI.
|
||||
|
||||
### Interactive
|
||||
|
||||
The first way is by clicking the "Wave AI" button in the command box or using the shortcut `ctrl + space`. This will open an interactive chat session where you can have a continuous conversation with the AI assistant.
|
||||
|
||||
<img height="200" src="/images/waveai.gif" />
|
||||
|
||||
In the interactive mode, you can ask follow-up questions, provide additional context, and engage in a more dynamic dialogue with Wave AI. This is particularly useful when you need to iterate on a problem or explore a topic in more depth.
|
||||
|
||||
### Chat command
|
||||
Alternatively, you can use the [chat](/reference/slashcommands#chat) command followed by your question to get a quick answer from the terminal.
|
||||
```
|
||||
Usage:
|
||||
/chat How do I resolve a merge conflict?
|
||||
```
|
||||
|
||||
This method is ideal for one-off queries or when you need a straightforward answer without the need for a back-and-forth conversation.
|
||||
|
||||
**Note:** Invoking Wave AI via the "/chat" command will result in an ad-hoc query, as each command in Wave gets its own command box. If you anticipate needing to ask follow-up questions or provide more context, it's recommended to use the interactive mode.
|
||||
|
||||
## Customization
|
||||
|
||||
Wave AI comes with default settings that work out of the box. However, you can customize your experience by modifying the following settings:
|
||||
|
||||
- **API Key**: If you prefer to use your own OpenAI API key, you can set it up in the Wave settings. This allows you to have more control over your API usage and billing.
|
||||
- **Model Selection**: Wave AI uses the ChatGPT "gpt-3.5-turbo" model by default, but you can choose a different model that suits your needs. Simply update the model settings in the Wave configuration.
|
||||
- **API Base URL**: If you want to use Azure models or other 3rd party APIs compatible with the OpenAI API, you can change the base URL using the following command:
|
||||
|
||||
```
|
||||
/client:set openaibaseurl="<BASE URL>"
|
||||
```
|
||||
Make sure that the API you specify has the same endpoints and protocol as the OpenAI API.
|
||||
|
||||
**Note:** In order to prevent abuse, telemetry must be enabled to use the cloud servers. There is currently a rate limit of 200 requests per day.
|
||||
|
||||
## Future Plans
|
||||
We're excited about the future of Wave AI and have plans to expand its capabilities. In the near future, we'll be introducing BYOLLM (Bring Your Own Large Language Model), which will enable users to connect Wave with any LLM they prefer. Possible integrations include Anthropic's Claude, Google's Gemini, or even local LLMs like OpenLLAMA. This reflects our commitment to user choice, allowing you to tailor your AI experience to your specific needs and concerns, whether they're related to privacy, ethics, or accessing the latest technology.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 3.7 MiB |
@@ -57,7 +57,7 @@
|
||||
{
|
||||
"group":"Features",
|
||||
"pages":[
|
||||
"features/chatGPT",
|
||||
"features/waveAI",
|
||||
"features/codeedit",
|
||||
"features/history",
|
||||
"features/images",
|
||||
|
||||
+30
-15
@@ -26,16 +26,17 @@ Commands that allow you to manage multiple bookmarks.
|
||||
Show all bookmarks.
|
||||
|
||||
## /chat
|
||||
Ask the AI-assistant a question from the terminal.
|
||||
Ask the AI-assistant an [ad-hoc] question from the terminal.
|
||||
|
||||
```
|
||||
/chat How do I resolve a merge conflict?
|
||||
```
|
||||
<Tip>
|
||||
For interactive sessions, use the "Wave AI" button in the command box, or use the shortcut `ctrl + space`.
|
||||
</Tip>
|
||||
|
||||
## /clear
|
||||
|
||||
Clear all commands from the current window.
|
||||
|
||||
```
|
||||
Usage:
|
||||
clear
|
||||
@@ -78,9 +79,11 @@ Shortcuts:
|
||||
- `Cmd-D` - Closes the editor. Note, this will prevent future saves (and shrink the editor to fit the current size of the content).
|
||||
- `Cmd-F` - Search the current file for a string using _whole word_, _regex_ and _match case_ options. `Cmd-F` also supports _find and replace_ by simply clicking the green dropdown arrow in the find box.
|
||||
|
||||
**Note:** Codeedit also includes a live preview feature for Markdown files. To activate, open a Markdown file in Codeedit and click the `show preview` button located in the top right corner. This feature enables simultaneous editing and rendering, offering a side-by-side view of your Markdown source and its live output for efficient and immediate feedback.
|
||||
Codeedit also includes a live preview feature for Markdown files. To activate, open a Markdown file in Codeedit and click the `show preview` button located in the top right corner. This feature enables simultaneous editing and rendering, offering a side-by-side view of your Markdown source and its live output for efficient and immediate feedback.
|
||||
|
||||
**Note:** See [codeview](#codeview) to view files in a _view only_ mode using the same native UI.
|
||||
<Tip>
|
||||
See [codeview](#codeview) to open files in a _view only_ mode using the same native UI.
|
||||
</Tip>
|
||||
|
||||
## /codeview
|
||||
|
||||
@@ -96,8 +99,9 @@ codeview [filename]
|
||||
|
||||
Both with and without the slash are allowed. Filename resolves against the current remote and current working directory.
|
||||
|
||||
**Note:** See [codeedit](#codeedit) to edit files using the same native UI.
|
||||
|
||||
<Tip>
|
||||
See [codeedit](#codeedit) to edit files using the same native UI.
|
||||
</Tip>
|
||||
|
||||
## /comment
|
||||
|
||||
@@ -141,7 +145,7 @@ Opens up the history viewer for all workspaces and tabs. Gives the user the abil
|
||||
|
||||
## /imageview
|
||||
|
||||
Utility for viewing image files in the terminal. Currently supported formats include `png`, `jpg`, `svg`, `bmp` and `gif`.
|
||||
Utility for viewing image files in the terminal. Currently supported formats include `png`, `jpg`, `bmp` and `gif`.
|
||||
|
||||
```
|
||||
Usage:
|
||||
@@ -171,12 +175,14 @@ Usage:
|
||||
```
|
||||
### /line:delete
|
||||
|
||||
Deletes a specified line from the current tab. Note, the line will still show up in history.
|
||||
Deletes a specified line from the current tab.
|
||||
|
||||
```
|
||||
Usage:
|
||||
/line:delete [line-arg]
|
||||
```
|
||||
**Note:** When a line is deleted using `/line:delete` it will still show up in history.
|
||||
|
||||
|
||||
### /line:set
|
||||
|
||||
@@ -225,7 +231,9 @@ mdview [filename]
|
||||
/mdview [filename]
|
||||
```
|
||||
|
||||
**Note:** A live preview of Markdown files can also be found in [codeedit](#codeedit) by clicking the "show preview" button in the top right of the editor. This allows you to edit and render Markdown content in real-time, displaying the output adjacent to the code editor for convenient and immediate visual feedback.
|
||||
<Tip>
|
||||
A live preview of Markdown files can also be found in [codeedit](#codeedit) by clicking the "show preview" button in the top right of the editor. This allows you to edit and render Markdown content in real-time, displaying the output adjacent to the code editor for convenient and immediate visual feedback.
|
||||
</Tip>
|
||||
|
||||
## /releasecheck
|
||||
|
||||
@@ -241,7 +249,9 @@ Turns on automatic checking for new releases. This will happen every 8 hours and
|
||||
|
||||
## /remote
|
||||
|
||||
Commands that create, manage, or update remotes (connections). Note that all `/remote` commands can also be accessed using `/connection`.
|
||||
Commands that create, manage, or update remotes (connections).
|
||||
|
||||
**Note:** All `/remote` commands can also be accessed using `/connection`.
|
||||
|
||||
### /remote:archive
|
||||
|
||||
@@ -379,13 +389,13 @@ With no arguments will archive the _current_ screen (tab). Otherwise a _screen i
|
||||
|
||||
### /screen:delete
|
||||
|
||||
Deletes the current screen, or specified screen when using `[screen-id].` Note, this will not remove the screens commands from history.
|
||||
|
||||
Deletes the current screen, or specified screen when using `[screen-id].`
|
||||
```
|
||||
Usage:
|
||||
/screen:delete
|
||||
/screen:delete [screen-id]
|
||||
```
|
||||
**Note:** This will not remove the screens commands from history.
|
||||
|
||||
### /screen:open
|
||||
|
||||
@@ -445,7 +455,7 @@ With no arguments will archive the current session. Otherwise a session id can b
|
||||
|
||||
### /session:delete
|
||||
|
||||
Deletes the current session, or specified session when using `[session-id].` Note, this will not remove the sessions commands from history.
|
||||
Deletes the current session, or specified session when using `[session-id].`
|
||||
|
||||
```
|
||||
Usage:
|
||||
@@ -453,6 +463,8 @@ Usage:
|
||||
/session:delete [session-id]
|
||||
```
|
||||
|
||||
**Note:** This will not remove the sessions commands from history.
|
||||
|
||||
### /session:open
|
||||
|
||||
Creates a new session.
|
||||
@@ -505,7 +517,7 @@ Closes the sidebar.
|
||||
|
||||
### /sidebar:open
|
||||
|
||||
Opens the sidebar. Takes an optional width param that specifies the preferred width of sidebar (can be either in percentage or px units). Note that the sidebar will not shrink past 200px, also note that percentage must be between 10-90%.
|
||||
Opens the sidebar. Takes an optional width param that specifies the preferred width of sidebar (can be either in percentage or px units).
|
||||
|
||||
```
|
||||
Usage:
|
||||
@@ -514,6 +526,9 @@ Usage:
|
||||
/sidebar:open width=600px
|
||||
```
|
||||
|
||||
**Note:** The sidebar will not shrink past 200px, also note that percentage must be between 10-90%.
|
||||
|
||||
|
||||
### /sidebar:remove
|
||||
|
||||
Removes the current line from the sidebar.
|
||||
|
||||
Reference in New Issue
Block a user