diff --git a/README.md b/README.md index 2725e4d8f28..748e50cd227 100644 --- a/README.md +++ b/README.md @@ -1,79 +1,93 @@ -
supersetlogo -

Superset

Run 10+ parallel coding agents on your machine

-[![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)
-## 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. 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. + +Workspaces + +### AI Agents +Run Claude Code, Codex, or other CLI agents in separate workspaces. Compare results and merge the best solution. + +AI Agents + +### Diff Viewer +Review changes, stage files, commit, and push—all from one interface. Create PRs directly from Superset. + +Diff Viewer + +### Terminal +Built-in terminal with multiple tabs per workspace. Sessions persist across app restarts. + +Terminal + +### IDE Integration +Open any workspace in [Cursor](https://cursor.sh) or [VS Code](https://code.visualstudio.com) with a single click. + +IDE Integration + +### Port Management +View and manage active ports across all workspaces. Kill stale processes with one click. + +Ports + ## 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. - -Screenshot 2025-12-24 at 9 33 35 PM +> [!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. - -Screenshot 2025-12-24 at 9 33 51 PM - -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. - -Screenshot 2025-12-24 at 9 34 04 PM - -### 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/) @@ -86,12 +100,18 @@ 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. @@ -99,11 +119,8 @@ See the [CONTRIBUTING.md](CONTRIBUTING.md) for instructions and code of conduct. -## 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) @@ -111,35 +128,3 @@ See tips and motivation under `docs`: [docs/cookbook/README.md](docs/cookbook/RE ## License Distributed under the Apache 2.0 License. See [LICENSE.md](LICENSE.md) for more information. - - - -[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