Skip to content

update README #141

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

Merged
Kitenite merged 3 commits into from
Nov 25, 2025
Merged

update README #141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
64c9adb
update README
Kitenite Nov 24, 2025
5883712
cleanup
Kitenite Nov 24, 2025
0e4afe0
Update README.md
Kitenite Nov 25, 2025
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
47 changes: 23 additions & 24 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,52 +10,49 @@

</div>

Superset helps you run 100 CLI coding agents on your machine without losing your mind.

## Docs

See the Markdown wiki in `docs/`: [docs/README.md](docs/README.md).
## Motivation
What do you do when your coding agent is running? Our answer is to start another coding task in parallel. The best developer can run 10+ tasks in parallel.

With Superset, you can run 100.

## What you can do with Superset:

- [X] Create and organize parallel coding environment
- [X] Notify you when agents need your review
- [ ] Share context between different CLI agents
- [ ] Manage a lot of agents in parallel
- [ ] Create and clone your standard environment
- [ ] Seemlessly transition between local and cloud so you can code on the go
- [ ] Automate reviewing and adjusting with minimal input
- [X] Get notified when an agent needs your review
- [ ] Share context between your agents
- [ ] Code on the go with a cloud environment
- [ ] Automate reviewing and feedback
- [ ] Create and manage Git pull requests

<img alt="example-min" src="https://github.com/user-attachments/assets/9db68082-47f4-4076-92a0-85ac97572699" />
<img alt="example-min" src="assets/example.png" />
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Nov 24, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Add missing alt text to images (MD045).

Images should include descriptive alt text for accessibility and user experience. The images at line 27 and line 87 lack alt text.

Apply this diff to add alt text:

-<img alt="example-min" src="assets/example.png" />
+<img alt="Example of Superset interface showing parallel task management" src="assets/example.png" />

For line 87, update the contributor rocks image:

  <a href="https://github.com/superset-sh/superset/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=superset-sh/superset" />
+  <img alt="Contributors to the Superset repository" src="https://contrib.rocks/image?repo=superset-sh/superset" />
  </a>

Also applies to: 87-87

🤖 Prompt for AI Agents 
In README.md around lines 27 and 87, the <img> tags are missing descriptive alt
text which fails MD045; update the image elements to include meaningful alt
attributes — at line 27 add alt text describing the example screenshot (e.g.,
"example of project UI" or more specific description) and at line 87 add alt
text for the contributor rocks image (e.g., "contributors celebrating with rocks
graphic" or similar); ensure the alt strings are concise, descriptive, and
replace the empty/missing alt attributes for both images.


## Getting Started

<!-- TODO: Update links -->
[Download the app](https://superset.sh) or
[run locally](https://superset.sh).

### Usage

Superset creates a new workspace for each of your tasks. Each workspace is isolated and parallel.

<!-- [TODO: Add Image] -->
<br>
For each parallel tasks, Superset uses git worktree to clone a new branch on your machine.

We automatically set up your workspace by cloning env variables, installing dependencies, etc.
Automate copying env variables, installing dependencies, etc. through the app or with a setup script `./superset/setup.json`

<!-- [TODO: Add Image] -->

<!-- <img alt="example-min" src="assets/example.png" /> -->
<br>

Coding agents can be spun up and organized. They can pass messages between each other ping you when they are done.
Each workspace gets their own organized terminal system. You can create default presets.

<!-- [TODO: Add Image] -->

<!-- <img alt="example-min" src="assets/example.png" /> -->
<br>

Superset gives you a high level view of all the changes made and help you create and merge a PR in a few clicks
Superset monitors your running processes, notify you when changes are ready, and help coordinate between multiple agents.

<!-- [TODO: Add Image] -->
<!-- <img alt="example-min" src="assets/example.png" /> -->
<br>

### Our Tech Stack

Expand All @@ -80,13 +77,15 @@ create a pull request. You can also

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

#### Contributors

<a href="https://github.com/superset-sh/superset/graphs/contributors">
<img src="https://contrib.rocks/image?repo=superset-sh/superset" />
</a>

## Team
## Cookbook

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

## Contact Us
- [![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)
- [![Avi Twitter](https://img.shields.io/badge/Avi-@avimakesrobots-555?logo=x)](https://x.com/avimakesrobots)
Expand Down
Binary file added assets/example.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 0 additions & 2 deletions docs/README.md
View file
Open in desktop

This file was deleted.

20 changes: 20 additions & 0 deletions docs/cookbook/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,3 +86,23 @@ Plan as a separate step:
### Code Quality

Linter, unit tests, and type-safety can be huge help. This gives valuable feedback to agents.


<!--
Drafts:

#### 1. Create clones of your codebase
[Git Worktree](https://example.com) is a good tool for this. Automate any worktree setup you might have.

Treat each worktree/branch as a separate task assigned to a different engineer.

#### 2. Use different agents for different jobs
Different CLI agents are better for certain tasks such as planning, implementing, reviewing, and refactoring.

At the point of writing (Nov 2025), we use Codex for planning and reviewing, Claude Code for implementing, and Cursor Composer for refacting and cleanup.

#### 3. Organize your workspace
There's a high switching cost between

#### 4. Enforce type-safety, lint, and coding standards
-->
Loading