readme updates for durable sessions / wave ai#2886
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughThis pull request updates README.md to reposition the project toward AI integration and SSH resilience. It replaces the product description, expands and reorders feature bullets (including durable SSH sessions with automatic reconnection and a built-in graphical remote-file editor with inline previews), updates the Wave AI section to mention BYOK and local model support and revised Coming Soon items, simplifies installation notes (Windows WSH x64 only) and the Roadmap/links, and adjusts wording across docs. No code logic or exported/public APIs were changed. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
65-71:⚠️ Potential issue | 🟡 MinorClarify the Windows version requirement inconsistency between Wave Terminal and WSH helper.
The README shows conflicting Windows requirements:
- Line 65: Wave Terminal requires "Windows 10 1809 or later (x64)"
- Line 71: WSH helper requires "Windows 10 or later (x64)"
A helper component typically requires the same or stricter OS requirements than the main application. Please verify whether:
- The WSH helper truly supports Windows 10 versions earlier than 1809
- These requirements should be aligned
If WSH helper has different version requirements, document the reason.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 65 - 71, Update the README to remove the inconsistency between Wave Terminal and the WSH helper by verifying which Windows baseline is correct and then making the text explicit: confirm whether the WSH helper supports Windows 10 versions earlier than 1809 and, if not, change the WSH helper bullet ("WSH helper runs on... Windows 10 or later (x64)") to match Wave Terminal's requirement ("Windows 10 1809 or later (x64)"); if the WSH helper genuinely supports earlier builds, add a short justification next to the WSH helper bullet explaining why its minimum is lower (e.g., specific API compatibility), and ensure both “Wave Terminal” and “WSH helper” entries clearly state the exact Windows build requirement.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 16: The phrase "It works with any AI model" is too broad—update the
README sentence to accurately list supported providers and API types: mention
support for major providers (Ollama, LM Studio, vLLM, OpenAI, OpenRouter,
Gemini, Azure, and custom providers) and clarify support for OpenAI-compatible
models and specific API types (openai-chat, openai-responses, google-gemini)
instead of claiming universal compatibility; replace the original sentence with
a concise line that either enumerates these providers or says "major AI
providers and OpenAI-compatible models" and optionally references custom
provider configuration.
---
Outside diff comments:
In `@README.md`:
- Around line 65-71: Update the README to remove the inconsistency between Wave
Terminal and the WSH helper by verifying which Windows baseline is correct and
then making the text explicit: confirm whether the WSH helper supports Windows
10 versions earlier than 1809 and, if not, change the WSH helper bullet ("WSH
helper runs on... Windows 10 or later (x64)") to match Wave Terminal's
requirement ("Windows 10 1809 or later (x64)"); if the WSH helper genuinely
supports earlier builds, add a short justification next to the WSH helper bullet
explaining why its minimum is lower (e.g., specific API compatibility), and
ensure both “Wave Terminal” and “WSH helper” entries clearly state the exact
Windows build requirement.
| [](https://app.fossa.com/projects/git%2Bgithub.com%2Fwavetermdev%2Fwaveterm?ref=badge_shield) | ||
|
|
||
| Wave is an open-source terminal that combines traditional terminal features with graphical capabilities like file previews, web browsing, and AI assistance. It runs on MacOS, Linux, and Windows. | ||
| Wave is an open-source, AI-integrated terminal for macOS, Linux, and Windows. It works with any AI model. Bring your own API keys for OpenAI, Claude, or Gemini, or run local models via Ollama and LM Studio. No accounts required. |
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
Wave Terminal AI model support documentation
💡 Result:
Wave Terminal’s current (“v0.13+”) documentation for AI model support is centered on Wave AI Modes:
- Wave AI (Local Models + BYOK) — how to configure supported providers/models via
~/.config/waveterm/waveai.json, including provider presets and examples for Ollama, LM Studio, vLLM, plus supported providers (openai, openrouter, google/gemini, azure, azure-legacy, custom) and API types (openai-chat, openai-responses, google-gemini). [1] - Release notes (v0.13.0+) — background on the shift to local models/BYOK and OpenAI-compatible
/v1/chat/completionssupport, plus Gemini integration. [2] - AI Presets (Deprecated) — older preset-based configuration (kept for legacy/reference). [3]
- Legacy docs (deprecated pre-0.8.0 Wave) — older “supported LLMs”/OpenAI setup docs. [4]
Sources: [1] [2] [3] [4]
Qualify the "any AI model" claim—it's inaccurate as stated.
The statement "It works with any AI model" overstates capabilities. Wave Terminal actually supports specific providers (Ollama, LM Studio, vLLM, OpenAI, OpenRouter, Gemini, Azure, and custom) with specific API types (openai-chat, openai-responses, google-gemini). While it does support OpenAI-compatible models and custom providers via configuration, this is not the same as supporting "any AI model." Revise to accurately reflect that it works with major AI providers and OpenAI-compatible models, or specify the supported providers/configurations explicitly.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 16, The phrase "It works with any AI model" is too
broad—update the README sentence to accurately list supported providers and API
types: mention support for major providers (Ollama, LM Studio, vLLM, OpenAI,
OpenRouter, Gemini, Azure, and custom providers) and clarify support for
OpenAI-compatible models and specific API types (openai-chat, openai-responses,
google-gemini) instead of claiming universal compatibility; replace the original
sentence with a concise line that either enumerates these providers or says
"major AI providers and OpenAI-compatible models" and optionally references
custom provider configuration.
![kiloconnect[bot]](https://avatars.githubusercontent.com/in/2193792?s=60&v=4){kind=small}
README.md
Outdated
| - Rich customization including tab themes, terminal styles, and background images | ||
| - Powerful `wsh` command system for managing your workspace from the CLI and sharing data between terminal sessions | ||
| - Connected file management with `wsh file` - seamlessly copy and sync files between local, remote SSH hosts, Wave filesystem, and S3 | ||
| - Connected file management with `wsh file` - seamlessly copy and sync files between local and remote SSH hosts. |
There was a problem hiding this comment.
SUGGESTION: Style inconsistency - this bullet point ends with a period while all other bullet points in the Key Features section do not.
| - Connected file management with `wsh file` - seamlessly copy and sync files between local and remote SSH hosts. | |
| - Connected file management with `wsh file` - seamlessly copy and sync files between local and remote SSH hosts |
Code Review SummaryStatus: No New Issues Found | Recommendation: Merge Review NotesThis PR updates the README.md with improved messaging and documentation links. The changes are primarily marketing and documentation improvements:
All changes appear intentional and appropriate. No bugs, runtime errors, or logic issues detected. Files Reviewed (1 file)
|
1 participant
readme hasn't been updated in a while and was out of date. update the hero text, wave ai section, and add durable sessions.