Skip to content

docs: update README with new screenshots and features #992

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Kitenite wants to merge 1 commit into from
Closed

docs: update README with new screenshots and features #992

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
157 changes: 71 additions & 86 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,79 +1,93 @@
<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
<div align="center">
<img width="600" alt="supersetlogo" src="https://github.com/user-attachments/assets/43c1bde8-93f5-4f53-9db4-187f632051a2" />


<h3 align="center">Superset</h3>
<p align="center">
Run 10+ parallel coding agents on your machine
</p>

[![Superset Twitter](https://img.shields.io/badge/@superset_sh-555?logo=x)](https://x.com/superset_sh)
[![Superset Twitter](https://img.shields.io/badge/Discord-555?logo=discord)]([https://x.com/superset_sh](https://discord.gg/cZeD9WYcV7))
[![Twitter](https://img.shields.io/badge/@superset_sh-555?logo=x)](https://x.com/superset_sh)
[![Discord](https://img.shields.io/badge/Discord-555?logo=discord)](https://discord.gg/cZeD9WYcV7)
[![Docs](https://img.shields.io/badge/Docs-555?logo=gitbook&logoColor=white)](https://docs.superset.sh)

</div>

## A Terminal Built for Coding Agents
Run 10+ CLI coding agents like Claude Code, Codex, etc. in parallel on your machine.
Spin up new coding tasks while waiting for your current agent to finish. Quickly switch between tasks as they need your attention.
## A Desktop App for Parallel AI Coding

Run AI coding agents like [Claude Code](https://docs.anthropic.com/en/docs/claude-code), [Codex](https://openai.com/index/introducing-codex/), and more in isolated workspaces. Each workspace is a [git worktree](https://git-scm.com/docs/git-worktree) with its own branch, terminal, and ports. Work on multiple features simultaneously without conflicts.
Comment on lines +15 to +17
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🌐 Web query:

Claude Code documentation anthropic

💡 Result:

Anthropic’s Claude Code documentation is hosted on the official Anthropic Docs site under /docs/claude-code/. The main entry points are:

  • Overview (start here): what Claude Code is and a 30-second install/start (npm install -g @anthropic-ai/claude-code``, then run claude in your project). [1]
  • Setup / Getting started: system requirements (Node.js 18+, macOS/Linux/Windows via WSL or Git Bash), install options, and authentication methods (Anthropic Console, Claude app plans, or Bedrock/Vertex). [2]
  • Identity & Access Management (IAM): team auth options (Console/SSO, Bedrock, Vertex) and role-based access plus permission controls. [3]

Sources: Anthropic Docs — Claude Code Overview [1], Setup [2], IAM [3].

🌐 Web query:

OpenAI Codex documentation

💡 Result:

  • Codex overview (product page): what Codex is and how to get started (CLI install command, surfaces like IDE/terminal/cloud). [1]

    https://openai.com/codex/

  • Codex CLI docs: install/run/upgrade, OS support, interactive TUI, scripting, cloud tasks, web search, approval modes, MCP, etc. [2]

    https://developers.openai.com/codex/cli/

  • API “Code generation” guide (platform docs): how to use Codex in apps, and an example calling a Codex coding model via the Responses API. [3]

    https://platform.openai.com/docs/guides/code-generation

  • Background + rollout details (blog): “Introducing Codex” (research preview details) and GA announcement (features like Slack integration, SDK, admin tools). [4][5]

    https://openai.com/index/introducing-codex/
https://openai.com/index/codex-now-generally-available/

🌐 Web query:

git worktree official documentation

💡 Result:

The official Git documentation for git worktree (manual page) is on git-scm.com:

https://git-scm.com/docs/git-worktree

It covers the command synopsis (add, list, lock, move, prune, remove, repair, unlock), behavior of “main” vs “linked” worktrees, and related configuration/details. [1]

Update Codex documentation link to current reference.

The Claude Code and git worktree links are correct. However, the Codex link points to an old blog announcement from when Codex was introduced. Update to the current product page: https://openai.com/codex/ or the API documentation at https://platform.openai.com/docs/guides/code-generation.

🤖 Prompt for AI Agents 
In `@README.md` around lines 15 - 17, Replace the outdated Codex URL in the README
line that references "Codex" with the current product or docs link; locate the
"Codex" anchor in the README (the text
'[Codex](https://openai.com/index/introducing-codex/)') and update its href to
either 'https://openai.com/codex/' or
'https://platform.openai.com/docs/guides/code-generation' so the link points to
the current Codex resource.


https://github.com/user-attachments/assets/d85ec84f-34de-4e17-9d44-5ccbd225566f

## Features

### Workspaces
Each workspace is an isolated git worktree on its own branch. Create workspaces from new branches, existing branches, or pull requests.

<img width="700" alt="Workspaces" src="./apps/docs/public/images/branches.png" />

### AI Agents
Run Claude Code, Codex, or other CLI agents in separate workspaces. Compare results and merge the best solution.

<img width="700" alt="AI Agents" src="./apps/docs/public/images/agents.png" />

### Diff Viewer
Review changes, stage files, commit, and push—all from one interface. Create PRs directly from Superset.

<img width="700" alt="Diff Viewer" src="./apps/docs/public/images/changes.png" />

### Terminal
Built-in terminal with multiple tabs per workspace. Sessions persist across app restarts.

<img width="700" alt="Terminal" src="./apps/docs/public/images/terminal.png" />

### IDE Integration
Open any workspace in [Cursor](https://cursor.sh) or [VS Code](https://code.visualstudio.com) with a single click.

<img width="700" alt="IDE Integration" src="./apps/docs/public/images/open-in.png" />

### Port Management
View and manage active ports across all workspaces. Kill stale processes with one click.

<img width="700" alt="Ports" src="./apps/docs/public/images/ports.png" />

## Getting Started

Prerequisites:
1. Install [Bun](https://bun.sh/) (package manager and Node runtime)
2. Clone the repo from GitHub
```
git clone https://github.com/superset-sh/superset.git
```
3. Set up environment variables (choose one):
### Requirements
- macOS (Apple Silicon or Intel)
- [Git](https://git-scm.com/) installed
- [GitHub CLI](https://cli.github.com/) authenticated (`gh auth status`)

**Option A: Full setup**
```bash
cp .env.example .env
```
Then edit `.env` and fill in the values
### Development Setup

**Option B: Skip env validation**
```bash
export SKIP_ENV_VALIDATION=1
```
This skips environment validation, useful for quickly running the app without external services.
Clone the repo:
```bash
git clone https://github.com/superset-sh/superset.git
cd superset
```

Install dependencies:
Set up environment variables:
```bash
bun install
cp .env.example .env
# Edit .env and fill in values, or:
export SKIP_ENV_VALIDATION=1 # Skip validation for quick setup
```
Run in dev mode:

Install and run:
```bash
bun install
bun run dev
```
Build desktop app:

Build the desktop app:
```bash
bun run build
open apps/desktop/release
open apps/desktop/release
```

> [!NOTE]
> While Electron is cross-platform, Superset Desktop has only been built and tested on **macOS**. Other platforms are currently untested and may not work as expected.

### Usage

For each parallel tasks, Superset uses git worktrees to clone a new branch on your machine. Automate copying env variables, installing dependencies, etc. through a config file (`.superset/config.json`).
Each workspace gets their own organized terminal system. You can create default presets.

<img width="602" height="445" alt="Screenshot 2025-12-24 at 9 33 35 PM" src="https://github.com/user-attachments/assets/d9a2cc66-722c-4e10-bb58-5c96b594c577" />
> [!NOTE]
> While Electron is cross-platform, Superset has only been tested on **macOS**.

Superset monitors your running agents, notify you when changes are ready, and help coordinate between multiple agents. There's a diff view with editor built in so you can quickly inspect and edit agents' changes.

<img width="600" height="447" alt="Screenshot 2025-12-24 at 9 33 51 PM" src="https://github.com/user-attachments/assets/ff890049-67a8-432b-8edd-bf9ff846ae16" />

Superset is designed to be a superset of your existing tools. It works for any CLI agents that runs in the terminal. You can open your superset workspace in any apps like IDE, filesystem, terminal, etc.

<img width="602" height="445" alt="Screenshot 2025-12-24 at 9 34 04 PM" src="https://github.com/user-attachments/assets/1eb3fa42-db30-4a62-9a8f-22cb757b4866" />

### Tech Stack
## Tech Stack

[![Electron](https://img.shields.io/badge/Electron-191970?logo=Electron&logoColor=white)](https://www.electronjs.org/)
[![React](https://img.shields.io/badge/React-%2320232a.svg?logo=react&logoColor=%2361DAFB)](https://reactjs.org/)
Expand All @@ -86,60 +100,31 @@ Superset is designed to be a superset of your existing tools. It works for any C
[![Neon](https://img.shields.io/badge/Neon-00E9CA?logo=neon&logoColor=white)](https://neon.tech/)
[![tRPC](https://img.shields.io/badge/tRPC-2596BE?logo=trpc&logoColor=white)](https://trpc.io/)

## Documentation

See the full documentation at [docs.superset.sh](https://docs.superset.sh):
- [Quick Start](https://docs.superset.sh/quick-start)
- [Your First Workspace](https://docs.superset.sh/first-workspace)
- [Setup Scripts](https://docs.superset.sh/setup-teardown-scripts)
- [Keyboard Shortcuts](https://docs.superset.sh/keyboard-shortcuts)
- [FAQ](https://docs.superset.sh/faq)

## Contributing

If you have a suggestion that would make this better, please fork the repo and
create a pull request. You can also
[open issues](https://github.com/superset-sh/superset/issues).
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also [open issues](https://github.com/superset-sh/superset/issues).

See the [CONTRIBUTING.md](CONTRIBUTING.md) for instructions and code of conduct.

<a href="https://github.com/superset-sh/superset/graphs/contributors">
<img src="https://contrib.rocks/image?repo=superset-sh/superset" />
</a>
Comment on lines 118 to 120
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Add alt text to contributors image for accessibility.

The contributors image is missing alt text, which is important for accessibility and screen readers.

♿ Proposed fix to add alt text 
 <a href="https://github.com/superset-sh/superset/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=superset-sh/superset" />
+  <img alt="Contributors" src="https://contrib.rocks/image?repo=superset-sh/superset" />
 </a>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<a href="https://github.com/superset-sh/superset/graphs/contributors">
<img src="https://contrib.rocks/image?repo=superset-sh/superset" />
</a>
<a href="https://github.com/superset-sh/superset/graphs/contributors">
<img alt="Contributors" src="https://contrib.rocks/image?repo=superset-sh/superset" />
</a>
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

119-119: Images should have alternate text (alt text)

(MD045, no-alt-text)

🤖 Prompt for AI Agents 
In `@README.md` around lines 118 - 120, The contributors image tag in README.md
lacks an alt attribute; update the <img> element to include meaningful alt text
(e.g., alt="Contributors to superset-sh/superset") for accessibility and screen
readers by adding the alt attribute to the existing <img
src="https://contrib.rocks/image?repo=superset-sh/superset" /> tag.


## Cookbook

See tips and motivation under `docs`: [docs/cookbook/README.md](docs/cookbook/README.md).

## Follow Us

- [![Avi Twitter](https://img.shields.io/badge/Avi-@avimakesrobots-555?logo=x)](https://x.com/avimakesrobots)
- [![Kiet Twitter](https://img.shields.io/badge/Kiet-@flyakiet-555?logo=x)](https://x.com/flyakiet)
- [![Satya Twitter](https://img.shields.io/badge/Satya-@saddle_paddle-555?logo=x)](https://x.com/saddle_paddle)

## License

Distributed under the Apache 2.0 License. See [LICENSE.md](LICENSE.md) for more information.

<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->

[superset-twitter]: https://x.com/supersetdev
[kiet-twitter]: https://x.com/flyakiet
[satya-twitter]: https://x.com/saddle_paddle
[avi-twitter]: https://x.com/avimakesrobots
[contributors-shield]: https://img.shields.io/github/contributors/superset-sh/studio.svg?style=for-the-badge
[contributors-url]: https://github.com/superset-sh/superset/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/superset-sh/studio.svg?style=for-the-badge
[forks-url]: https://github.com/superset-sh/superset/network/members
[stars-shield]: https://img.shields.io/github/stars/superset-sh/studio.svg?style=for-the-badge
[stars-url]: https://github.com/superset-sh/superset/stargazers
[issues-shield]: https://img.shields.io/github/issues/superset-sh/studio.svg?style=for-the-badge
[issues-url]: https://github.com/superset-sh/superset/issues
[license-shield]: https://img.shields.io/github/license/superset-sh/studio.svg?style=for-the-badge
[license-url]: ./LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?logo=linkedin&colorB=555
[linkedin-url]: https://www.linkedin.com/company/superset-sh
[twitter-shield]: https://img.shields.io/badge/-Twitter-black?logo=x&colorB=555
[twitter-url]: https://x.com/supersetdev
[discord-shield]: https://img.shields.io/badge/-Discord-black?logo=discord&colorB=555
[discord-url]: https://discord.gg/hERDfFZCsH
[React.js]: https://img.shields.io/badge/react-%2320232a.svg?logo=react&logoColor=%2361DAFB
[React-url]: https://reactjs.org/
[TailwindCSS]: https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?logo=tailwind-css&logoColor=white
[Tailwind-url]: https://tailwindcss.com/
[Electron.js]: https://img.shields.io/badge/Electron-191970?logo=Electron&logoColor=white
[Electron-url]: https://www.electronjs.org/
[Vite.js]: https://img.shields.io/badge/vite-%23646CFF.svg?logo=vite&logoColor=white
[Vite-url]: https://vitejs.dev/
[product-screenshot]: assets/brand.png