Skip to content

Commit e2ff7f0

Browse files
committed
update more documentation
1 parent f0a00e7 commit e2ff7f0

6 files changed

Lines changed: 40 additions & 15 deletions

File tree

ROADMAP.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ Wave Terminal's AI assistant is already powerful and continues to evolve. Here's
1313
### AI Provider Support
1414

1515
- ✅ OpenAI (including gpt-5 and gpt-5-mini models)
16+
- ✅ Google Gemini (v0.13)
17+
- ✅ OpenRouter and custom OpenAI-compatible endpoints (v0.13)
18+
- ✅ Azure OpenAI (modern and legacy APIs) (v0.13)
19+
- ✅ Local AI models via Ollama, LM Studio, vLLM, and other OpenAI-compatible servers (v0.13)
1620

1721
### Context & Input
1822

@@ -32,33 +36,28 @@ Wave Terminal's AI assistant is already powerful and continues to evolve. Here's
3236

3337
### AI Configuration & Flexibility
3438

35-
- 🔷 BYOK (Bring Your Own Key) - Use your own API keys for any supported provider
39+
- ✅ BYOK (Bring Your Own Key) - Use your own API keys for any supported provider (v0.13)
40+
- ✅ Local AI agents - Run AI models locally on your machine (v0.13)
3641
- 🔧 Enhanced provider configuration options
3742
- 🔷 Context (add markdown files to give persistent system context)
3843

3944
### Expanded Provider Support
4045

41-
Top priorities are Claude (for better coding support), and the OpenAI Completions API which will allow us to interface with
42-
many more local/open models.
43-
4446
- 🔷 Anthropic Claude - Full integration with extended thinking and tool use
45-
- 🔷 OpenAI Completions API - Support for older model formats
46-
- 🤞 Google Gemini - Complete integration
47-
- 🤞 Local AI agents - Run AI models locally on your machine
4847

4948
### Advanced AI Tools
5049

5150
#### File Operations
5251

53-
- 🔧 AI file writing with intelligent diff previews
54-
- 🔧 Rollback support for AI-made changes
52+
- AI file writing with intelligent diff previews
53+
- Rollback support for AI-made changes
5554
- 🔷 Multi-file editing workflows
5655
- 🔷 Safe file modification patterns
5756

5857
#### Terminal Command Execution
5958

6059
- 🔧 Execute commands directly from AI
61-
- 🔧 Intelligent terminal state detection
60+
- Intelligent terminal state detection
6261
- 🔧 Command result capture and parsing
6362

6463
### Remote & Advanced Capabilities

docs/docs/secrets.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { VersionBadge } from "@site/src/components/versionbadge";
88

99
# Secrets
1010

11-
<VersionBadge version="v0.13" />
11+
<VersionBadge version="v0.13" noLeftMargin={true} />
1212

1313
Wave Terminal provides a secure way to store sensitive information like passwords, API keys, and tokens. Secrets are stored encrypted in your system's native keychain (macOS Keychain, Windows Credential Manager, or Linux Secret Service), ensuring your sensitive data remains protected.
1414

docs/docs/waveai-modes.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ id: "waveai-modes"
44
title: "Wave AI (Local Models + BYOK)"
55
---
66

7+
import { VersionBadge } from "@site/src/components/versionbadge";
8+
9+
<VersionBadge version="v0.13" noLeftMargin={true}/>
10+
711
Wave AI supports custom AI modes that allow you to use local models, custom API endpoints, and alternative AI providers. This gives you complete control over which models and providers you use with Wave's AI features.
812

913
## Configuration Overview

docs/docs/waveai.mdx

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,15 +74,32 @@ Supports text files, images, PDFs, and directories. Use `-n` for new chat, `-s`
7474
File system operations require explicit approval. You control all file access.
7575
:::
7676

77+
## Local Models & BYOK
78+
79+
Wave AI supports using your own AI models and API keys:
80+
81+
- **Local Models**: Run AI models locally with [Ollama](https://ollama.ai), [LM Studio](https://lmstudio.ai), [vLLM](https://docs.vllm.ai), and other OpenAI-compatible servers
82+
- **BYOK (Bring Your Own Key)**: Use your own API keys with OpenAI, OpenRouter, Google AI (Gemini), Azure OpenAI, and other cloud providers
83+
- **Multiple Modes**: Configure and switch between multiple AI providers and models
84+
- **Privacy**: Keep your data local or use your preferred cloud provider
85+
86+
See the [**Local Models & BYOK guide**](./waveai-modes.mdx) for complete configuration instructions, examples, and troubleshooting.
87+
7788
## Privacy
7889

90+
**Default Wave AI Service:**
7991
- Messages are proxied through the Wave Cloud AI service (powered by OpenAI's APIs). Please refer to OpenAI's privacy policy for details on how they handle your data.
8092
- Wave does not store your chats, attachments, or use them for training
8193
- Usage counters included in anonymous telemetry
8294
- File access requires explicit approval
8395

96+
**Local Models & BYOK:**
97+
- When using local models, your chat data never leaves your machine
98+
- When using BYOK with cloud providers, requests are sent directly to your chosen provider
99+
- Refer to your provider's privacy policy for details on how they handle your data
100+
84101
:::info Under Active Development
85-
Wave AI is in active beta with included AI credits while we refine the experience. BYOK will be available once we've stabilized core features and gathered feedback on what works best. Share feedback in our [Discord](https://discord.gg/XfvZ334gwU).
102+
Wave AI is in active beta with included AI credits while we refine the experience. Share feedback in our [Discord](https://discord.gg/XfvZ334gwU).
86103

87104
**Coming Soon:**
88105
- **Remote File Access**: Read files on SSH-connected systems

docs/src/components/versionbadge.css

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@
1212
white-space: nowrap;
1313
}
1414

15+
.version-badge.no-left-margin {
16+
margin-left: 0;
17+
}
18+
1519
[data-theme="dark"] .version-badge {
1620
background-color: var(--ifm-color-primary-dark);
1721
color: var(--ifm-background-color);
18-
}
22+
}

docs/src/components/versionbadge.tsx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@ import "./versionbadge.css";
22

33
interface VersionBadgeProps {
44
version: string;
5+
noLeftMargin?: boolean;
56
}
67

7-
export function VersionBadge({ version }: VersionBadgeProps) {
8-
return <span className="version-badge">{version}</span>;
8+
export function VersionBadge({ version, noLeftMargin }: VersionBadgeProps) {
9+
return <span className={`version-badge${noLeftMargin ? " no-left-margin" : ""}`}>{version}</span>;
910
}

0 commit comments

Comments
 (0)