Repository: superset-sh/superset

Stars: 9731

CLAUDE.md Copy Chapter

@AGENTS.md

README.md Copy Chapter

<div align="center">

<img width="full" alt="Superset" src="apps/marketing/public/images/readme-hero.png" />

The Code Editor for AI Agents Copy Section


<br />

Orchestrate swarms of Claude Code, Codex, and more in parallel.<br />
Works with any CLI agent. Built for local worktree-based development.

<br />

Download for macOS &nbsp;&bull;&nbsp; Documentation &nbsp;&bull;&nbsp; Changelog &nbsp;&bull;&nbsp; Discord

<br />

</div>

Code 10x Faster With No Switching Cost Copy Chapter

Superset orchestrates CLI-based coding agents across isolated git worktrees, with built-in terminal, review, and open-in-editor workflows.

- Run multiple agents simultaneously without context switching overhead
- Isolate each task in its own git worktree so agents don't interfere with each other
- Monitor all your agents from one place and get notified when they need attention
- Review and edit changes quickly with the built-in diff viewer and editor
- Open any workspace where you need it with one-click handoff to your editor or terminal

Wait less, ship more.

Features Copy Chapter

| Feature | Description |
|:--------|:------------|
| Parallel Execution | Run 10+ coding agents simultaneously on your machine |
| Worktree Isolation | Each task gets its own branch and working directory |
| Agent Monitoring | Track agent status and get notified when changes are ready |
| Built-in Diff Viewer | Inspect and edit agent changes without leaving the app |
| Workspace Presets | Automate env setup, dependency installation, and more |
| Universal Compatibility | Works with any CLI agent that runs in a terminal |
| Quick Context Switching | Jump between tasks as they need your attention |
| IDE Integration | Open any workspace in your favorite editor with one click |

Supported Agents Copy Chapter

Superset works with any CLI-based coding agent, including:

| Agent | Status |
|:------|:-------|
| Amp Code | Fully supported |
| Claude Code | Fully supported |
| OpenAI Codex CLI | Fully supported |
| Cursor Agent | Fully supported |
| Gemini CLI | Fully supported |
| GitHub Copilot | Fully supported |
| OpenCode | Fully supported |
| Pi | Fully supported |
| Any CLI agent | Will work |

If it runs in a terminal, it runs on Superset

Requirements Copy Chapter

| Requirement | Details |
|:------------|:--------|
| OS | macOS (Windows/Linux untested) |
| Runtime | Bun v1.0+ |
| Version Control | Git 2.20+ |
| GitHub CLI | gh |
| Caddy | caddy (for dev server) |

Getting Started Copy Chapter

Quick Start (Pre-built) Copy Section

Download Superset for macOS

Build from Source Copy Section

<details>
<summary>Click to expand build instructions</summary>

1. Clone the repository

git clone https://github.com/superset-sh/superset.git
cd superset

2. Set up environment variables (choose one):

Option A: Full setup

cp .env.example .env
Edit .env and fill in the values

Option B: Skip env validation (for quick local testing)

cp .env.example .env
echo 'SKIP_ENV_VALIDATION=1' >> .env

3. Set up Caddy (reverse proxy for Electric SQL streams):

Install caddy: brew install caddy (macOS) or see https://caddyserver.com/docs/install

cp Caddyfile.example Caddyfile

4. Install dependencies and run

bun install
bun run dev

5. Build the desktop app

bun run build
open apps/desktop/release

</details>

Keyboard Shortcuts Copy Chapter

All shortcuts are customizable via Settings > Keyboard Shortcuts (⌘/). See full documentation.

Workspace Navigation Copy Section

| Shortcut | Action |
|:---------|:-------|
| ⌘1-9 | Switch to workspace 1-9 |
| ⌘⌥↑/↓ | Previous/next workspace |
| ⌘N | New workspace |
| ⌘⇧N | Quick create workspace |
| ⌘⇧O | Open project |

Terminal Copy Section

| Shortcut | Action |
|:---------|:-------|
| ⌘T | New tab |
| ⌘W | Close pane/terminal |
| ⌘D | Split right |
| ⌘⇧D | Split down |
| ⌘K | Clear terminal |
| ⌘F | Find in terminal |
| ⌘⌥←/→ | Previous/next tab |
| Ctrl+1-9 | Open preset 1-9 |

Layout Copy Section

| Shortcut | Action |
|:---------|:-------|
| ⌘B | Toggle workspaces sidebar |
| ⌘L | Toggle changes panel |
| ⌘O | Open in external app |
| ⌘⇧C | Copy path |

Configuration Copy Chapter

Configure workspace setup and teardown in .superset/config.json. See full documentation.

{
  "setup": ["./.superset/setup.sh"],
  "teardown": ["./.superset/teardown.sh"]
}

| Option | Type | Description |
|:-------|:-----|:------------|
| setup | string[] | Commands to run when creating a workspace |
| teardown | string[] | Commands to run when deleting a workspace |

Example setup script Copy Section

#!/bin/bash
.superset/setup.sh
Copy environment variables

cp ../.env .env
Install dependencies

bun install
Run any other setup tasks

echo "Workspace ready!"

Scripts have access to environment variables:
- SUPERSET_WORKSPACE_NAME — Name of the workspace
- SUPERSET_ROOT_PATH — Path to the main repository

Mastra Dependencies Copy Chapter

This repo uses the published upstream mastracode and @mastra/* packages directly. Avoid adding custom tarball overrides unless there is a repo-specific blocker.

Tech Stack Copy Chapter

<p>
<a href="https://www.electronjs.org/"><img src="https://img.shields.io/badge/Electron-191970?logo=Electron&logoColor=white" alt="Electron" /></a>
<a href="https://reactjs.org/"><img src="https://img.shields.io/badge/React-%2320232a.svg?logo=react&logoColor=%2361DAFB" alt="React" /></a>
<a href="https://tailwindcss.com/"><img src="https://img.shields.io/badge/Tailwindcss-%2338B2AC.svg?logo=tailwind-css&logoColor=white" alt="TailwindCSS" /></a>
<a href="https://bun.sh/"><img src="https://img.shields.io/badge/Bun-000000?logo=bun&logoColor=white" alt="Bun" /></a>
<a href="https://turbo.build/"><img src="https://img.shields.io/badge/Turborepo-EF4444?logo=turborepo&logoColor=white" alt="Turborepo" /></a>
<a href="https://vitejs.dev/"><img src="https://img.shields.io/badge/Vite-%23646CFF.svg?logo=vite&logoColor=white" alt="Vite" /></a>
<a href="https://biomejs.dev/"><img src="https://img.shields.io/badge/Biome-339AF0?logo=biome&logoColor=white" alt="Biome" /></a>
<a href="https://orm.drizzle.team/"><img src="https://img.shields.io/badge/Drizzle%20ORM-FFE873?logo=drizzle&logoColor=black" alt="Drizzle ORM" /></a>
<a href="https://neon.tech/"><img src="https://img.shields.io/badge/Neon-00E9CA?logo=neon&logoColor=white" alt="Neon" /></a>
<a href="https://trpc.io/"><img src="https://img.shields.io/badge/tRPC-2596BE?logo=trpc&logoColor=white" alt="tRPC" /></a>
</p>

Private by Default Copy Chapter

- Source Available — Full source is available on GitHub under Elastic License 2.0 (ELv2).
- Explicit Connections — You choose which agents, providers, and integrations to connect.

Contributing Copy Chapter

We welcome contributions! If you have a suggestion that would make Superset better:

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

You can also open issues for bugs or feature requests.

See CONTRIBUTING.md for detailed 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>

Community Copy Chapter

Join the Superset community to get help, share feedback, and connect with other users:

- Discord — Chat with the team and community
- Twitter — Follow for updates and announcements
- GitHub Issues — Report bugs and request features
- GitHub Discussions — Ask questions and share ideas

Team Copy Section


License Copy Chapter

Distributed under the Elastic License 2.0 (ELv2). See LICENSE.md for more information.