Repository navigation
docs(readme): advertise recent features, CLI/SDK/MCP surfaces, and Mistral Vibe - #5676
Merged
Merged
Conversation
…stral Vibe The README still described the March feature set. Bring it up to date with what shipped since: expanded features table (terminal, command palette, remote workspaces, automations, custom agents, Slack/Linear), a new surfaces section (desktop, CLI, SDK, MCP) with CLI install commands, Mistral Vibe in the agents table, and the run script + SUPERSET_WORKSPACE_PATH in the configuration docs.
Contributor
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughREADME.md expands product feature and supported-agent descriptions, documents Desktop App, CLI, SDK, MCP, and iOS surfaces, and adds workspace run-script configuration with the ChangesREADME documentation updates
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
|
Ready to review this PR? Stage has broken it down into 3 individual chapters for you:
Chapters generated by Stage for commit e59e3ed on Jul 13, 2026 10:02pm UTC. |
Contributor
Greptile SummaryThis PR updates
Confidence Score: 4/5Safe to merge after resolving the plan-gating contradiction for Remote Workspaces — all other additions are accurate and verified against the docs source files. The Remote Workspaces row advertises availability "on every plan" while the corresponding docs page still carries README.md — specifically the Remote Workspaces row in the features table
|
| Filename | Overview |
|---|---|
| README.md | Documentation-only update expanding features table, adding CLI/SDK/MCP surfaces section, Mistral Vibe agent entry, and run script + env var docs — all well-sourced from the docs site, with one plan-gating inconsistency flagged (remote workspaces claimed as "every plan" while docs still mark it Pro) |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
User([User / Developer])
User -->|Full IDE experience| Desktop["Desktop App\n(terminals, diff viewer,\nbrowser, automations)"]
User -->|Shell / CI| CLI["CLI\nsuperset binary"]
User -->|Scripts & services| SDK["TypeScript SDK\n@superset_sh/sdk"]
User -->|AI agents| MCP["MCP Server\n(Claude Code, Codex, Cursor)"]
Desktop --> Backend[Superset Backend]
CLI --> Backend
SDK --> Backend
MCP --> Backend
Backend --> Workspaces[(Workspaces & Worktrees)]
Backend --> Relay[Superset Relay]
Relay -->|Remote access| RemoteHost["Remote Host\n(another machine)"]
RemoteHost --> Workspaces
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
User([User / Developer])
User -->|Full IDE experience| Desktop["Desktop App\n(terminals, diff viewer,\nbrowser, automations)"]
User -->|Shell / CI| CLI["CLI\nsuperset binary"]
User -->|Scripts & services| SDK["TypeScript SDK\n@superset_sh/sdk"]
User -->|AI agents| MCP["MCP Server\n(Claude Code, Codex, Cursor)"]
Desktop --> Backend[Superset Backend]
CLI --> Backend
SDK --> Backend
MCP --> Backend
Backend --> Workspaces[(Workspaces & Worktrees)]
Backend --> Relay[Superset Relay]
Relay -->|Remote access| RemoteHost["Remote Host\n(another machine)"]
RemoteHost --> Workspaces
Prompt To Fix All With AI
Fix the following 2 code review issues. Work through them one at a time, proposing concise fixes.
---
### Issue 1 of 2
README.md:50
**"On every plan" contradicts the docs**
The features table now says Remote Workspaces are available "on every plan", but `apps/docs/content/docs/remote-workspaces.mdx` carries `pro: true` in its frontmatter, which the docs site uses to gate that page behind the Pro badge. The PR notes already call this out as an open question — the phrase should either be removed until the docs are updated to match the changelog, or the docs frontmatter should be corrected alongside this README change, so both surfaces agree on what's actually available.
### Issue 2 of 2
README.md:89
The SDK also works in Deno, per `apps/docs/content/docs/sdk/getting-started.mdx` ("Everything is fully typed and works in Node, Bun, and Deno"). Omitting Deno here while the docs list it creates a minor inconsistency for Deno users landing on the repo.
```suggestion
| [**TypeScript SDK**](https://docs.superset.sh/sdk/getting-started) | Drive Superset programmatically with [`@superset_sh/sdk`](https://www.npmjs.com/package/@superset_sh/sdk) from Node, Bun, Deno, or the browser |
```
Reviews (1): Last reviewed commit: "docs(readme): advertise recent features,..." | Re-trigger Greptile
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| | **Built-in Terminal** | Tabs, splits, presets, persistent sessions, and an optional rich prompt editor | | ||
| | **Built-in Diff Viewer** | Inspect, comment on, and edit agent changes without leaving the app | | ||
| | **Command Palette** | Jump to any workspace, action, or setting from one search box | | ||
| | **In-App Browser & Ports** | Preview running dev servers, with ports detected per workspace | |
Contributor
There was a problem hiding this comment.
The features table now says Remote Workspaces are available "on every plan", but apps/docs/content/docs/remote-workspaces.mdx carries pro: true in its frontmatter, which the docs site uses to gate that page behind the Pro badge. The PR notes already call this out as an open question — the phrase should either be removed until the docs are updated to match the changelog, or the docs frontmatter should be corrected alongside this README change, so both surfaces agree on what's actually available.
Prompt To Fix With AI
This is a comment left during a code review.
Path: README.md
Line: 50
Comment:
**"On every plan" contradicts the docs**
The features table now says Remote Workspaces are available "on every plan", but `apps/docs/content/docs/remote-workspaces.mdx` carries `pro: true` in its frontmatter, which the docs site uses to gate that page behind the Pro badge. The PR notes already call this out as an open question — the phrase should either be removed until the docs are updated to match the changelog, or the docs frontmatter should be corrected alongside this README change, so both surfaces agree on what's actually available.
How can I resolve this? If you propose a fix, please make it concise.| |:--------|:-------------| | ||
| | [**Desktop App**](https://github.com/superset-sh/superset/releases/latest) | The full IDE: terminals, diff viewer, in-app browser, automations | | ||
| | [**CLI**](https://docs.superset.sh/cli/getting-started) | A single `superset` binary to manage workspaces, agents, terminals, and hosts from any shell | | ||
| | [**TypeScript SDK**](https://docs.superset.sh/sdk/getting-started) | Drive Superset programmatically with [`@superset_sh/sdk`](https://www.npmjs.com/package/@superset_sh/sdk) from Node, Bun, or the browser | |
Contributor
There was a problem hiding this comment.
apps/docs/content/docs/sdk/getting-started.mdx ("Everything is fully typed and works in Node, Bun, and Deno"). Omitting Deno here while the docs list it creates a minor inconsistency for Deno users landing on the repo.
Suggested change
| | [**TypeScript SDK**](https://docs.superset.sh/sdk/getting-started) | Drive Superset programmatically with [`@superset_sh/sdk`](https://www.npmjs.com/package/@superset_sh/sdk) from Node, Bun, or the browser | | |
| | [**TypeScript SDK**](https://docs.superset.sh/sdk/getting-started) | Drive Superset programmatically with [`@superset_sh/sdk`](https://www.npmjs.com/package/@superset_sh/sdk) from Node, Bun, Deno, or the browser | |
Prompt To Fix With AI
This is a comment left during a code review.
Path: README.md
Line: 89
Comment:
The SDK also works in Deno, per `apps/docs/content/docs/sdk/getting-started.mdx` ("Everything is fully typed and works in Node, Bun, and Deno"). Omitting Deno here while the docs list it creates a minor inconsistency for Deno users landing on the repo.
```suggestion
| [**TypeScript SDK**](https://docs.superset.sh/sdk/getting-started) | Drive Superset programmatically with [`@superset_sh/sdk`](https://www.npmjs.com/package/@superset_sh/sdk) from Node, Bun, Deno, or the browser |
```
How can I resolve this? If you propose a fix, please make it concise.Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 73-76: Add descriptive alt attributes to the newly added OpenCode,
Pi, and Polygraph img elements in the agent support table, matching each icon to
its associated agent name and satisfying accessibility checks.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Contributor
🚀 Preview Deployment🔗 Preview Links
Preview updates automatically with new commits |
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
All reported issues were addressed across 1 file
Architecture diagram
sequenceDiagram
participant User as User / Developer
participant Desktop as Desktop App
participant CLI as CLI (superset binary)
participant SDK as TypeScript SDK (@superset_sh/sdk)
participant MCP as MCP Server
participant Workspace as Workspace (git worktree)
participant Backend as Superset Backend / API
Note over User,Backend: Multiple surfaces access same workspaces
User->>Desktop: Use full IDE (terminal, diff viewer, automations)
Desktop->>Workspace: Manage workspaces, run setup/teardown/run scripts
Workspace-->>Desktop: Return status, diffs, logs
User->>CLI: Run superset commands (manage workspaces, agents, terminals)
CLI->>Backend: API calls for workspace operations
Backend->>Workspace: Execute setup/teardown/run scripts
Workspace-->>Backend: Script results
Backend-->>CLI: Response (workspace list, agent status)
User->>SDK: Programmatic access from Node/Bun/browser
SDK->>Backend: API calls (create workspace, start agent)
Backend->>Workspace: Create worktree, clone repo
Workspace-->>Backend: Workspace ready
Backend-->>SDK: Workspace ID, status
User->>MCP: Let Claude Code / Codex manage workspaces
MCP->>Backend: Create/read/update workspaces
Backend->>Workspace: Agent session in isolated worktree
Workspace-->>Backend: Agent output, diffs
Backend-->>MCP: Workspace state, agent results
MCP-->>User: Workspace accessible from desktop/CLI/SDK
Note over User,Workspace: Remote workspaces on every plan
User->>Desktop: Connect to remote host
Desktop->>Backend: Remote workspace token/auth
Backend->>Workspace: Route commands to remote worktree
Workspace-->>Backend: Remote execution results
Backend-->>Desktop: Workspace accessible from anywhere
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
Contributor
There was a problem hiding this comment.
1 issue found across 1 file (changes from recent commits).
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="README.md">
<violation number="1" location="README.md:65">
P3: Screen readers will announce each agent name twice because the icon's non-empty `alt` text is followed by the identical visible link label. These icons are decorative alongside the text labels, so using `alt=""` on each supported-agent icon would preserve the label without duplicate announcements.</violation>
</file>
Tip: Review your code locally with the cubic CLI to iterate faster.
Re-trigger cubic
| | <picture><source media="(prefers-color-scheme: dark)" srcset="packages/ui/src/assets/icons/preset-icons/opencode-white.svg" /><img height="16" align="top" src="packages/ui/src/assets/icons/preset-icons/opencode.svg" /></picture> [OpenCode](https://github.com/opencode-ai/opencode) | Fully supported | | ||
| | <picture><source media="(prefers-color-scheme: dark)" srcset="packages/ui/src/assets/icons/preset-icons/pi-white.svg" /><img height="16" align="top" src="packages/ui/src/assets/icons/preset-icons/pi.svg" /></picture> [Pi](https://github.com/badlogic/pi-mono/tree/main/packages/coding-agent) | Fully supported | | ||
| | <picture><source media="(prefers-color-scheme: dark)" srcset="packages/ui/src/assets/icons/preset-icons/polygraph-white.svg" /><img height="16" align="top" src="packages/ui/src/assets/icons/preset-icons/polygraph.svg" /></picture> [Polygraph](https://trypolygraph.com/) | Fully supported | | ||
| | <img height="16" align="top" alt="Amp Code" src="packages/ui/src/assets/icons/preset-icons/amp.svg" /> [Amp Code](https://ampcode.com/) | Fully supported | |
Contributor
There was a problem hiding this comment.
P3: Screen readers will announce each agent name twice because the icon's non-empty alt text is followed by the identical visible link label. These icons are decorative alongside the text labels, so using alt="" on each supported-agent icon would preserve the label without duplicate announcements.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At README.md, line 65:
<comment>Screen readers will announce each agent name twice because the icon's non-empty `alt` text is followed by the identical visible link label. These icons are decorative alongside the text labels, so using `alt=""` on each supported-agent icon would preserve the label without duplicate announcements.</comment>
<file context>
@@ -62,18 +62,18 @@ Superset works with any CLI-based coding agent, including:
-| <picture><source media="(prefers-color-scheme: dark)" srcset="packages/ui/src/assets/icons/preset-icons/opencode-white.svg" /><img height="16" align="top" src="packages/ui/src/assets/icons/preset-icons/opencode.svg" /></picture> [OpenCode](https://github.com/opencode-ai/opencode) | Fully supported |
-| <picture><source media="(prefers-color-scheme: dark)" srcset="packages/ui/src/assets/icons/preset-icons/pi-white.svg" /><img height="16" align="top" src="packages/ui/src/assets/icons/preset-icons/pi.svg" /></picture> [Pi](https://github.com/badlogic/pi-mono/tree/main/packages/coding-agent) | Fully supported |
-| <picture><source media="(prefers-color-scheme: dark)" srcset="packages/ui/src/assets/icons/preset-icons/polygraph-white.svg" /><img height="16" align="top" src="packages/ui/src/assets/icons/preset-icons/polygraph.svg" /></picture> [Polygraph](https://trypolygraph.com/) | Fully supported |
+| <img height="16" align="top" alt="Amp Code" src="packages/ui/src/assets/icons/preset-icons/amp.svg" /> [Amp Code](https://ampcode.com/) | Fully supported |
+| <img height="16" align="top" alt="Claude Code" src="packages/ui/src/assets/icons/preset-icons/claude.svg" /> [Claude Code](https://github.com/anthropics/claude-code) | Fully supported |
+| <picture><source media="(prefers-color-scheme: dark)" srcset="packages/ui/src/assets/icons/preset-icons/codex-white.svg" /><img height="16" align="top" alt="OpenAI Codex CLI" src="packages/ui/src/assets/icons/preset-icons/codex.svg" /></picture> [OpenAI Codex CLI](https://github.com/openai/codex) | Fully supported |
</file context>
This was referenced Aug 5, 2026
This branch was previously deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
runscript option +SUPERSET_WORKSPACE_PATHenv var to the configuration section.Why / Context
The README still advertised the March feature set. A lot has shipped since (rich terminal input, remote hosts on every plan, automations, custom agents, the CLI/SDK/MCP surfaces, Mistral Vibe) and none of it was visible to someone landing on the repo.
Feature names and descriptions are pulled from the changelog, docs site, and pricing page so the README matches what we say elsewhere. Copy follows the house voice: no em dashes, no padding, swept with the usual grep.
Notes
Testing
apps/docs/content/docs/file names, the CLI install commands againstcli/getting-started.mdx, and therun/env-var additions againstsetup-teardown-scripts.mdx.Summary by cubic
Refreshes the README to showcase recent features, surfaces (desktop, CLI, TypeScript SDK, MCP), and Mistral Vibe. Adds CLI install steps plus config docs for
runscripts andSUPERSET_WORKSPACE_PATH.New Features
@superset_sh/sdk), MCP server, with install commands and an iOS note.runscripts andSUPERSET_WORKSPACE_PATH.Bug Fixes
Written for commit e59e3ed. Summary will update on new commits.
Summary by CodeRabbit
.superset/config.jsonwith workspace setup/teardown/run script support via a newrunarray and documentedSUPERSET_WORKSPACE_PATH.