From 56fe7838e7ec08fdfc7e3d57c46081ed11674aa4 Mon Sep 17 00:00:00 2001 From: Kiet Ho Date: Sun, 23 Nov 2025 12:50:29 -0800 Subject: [PATCH 1/3] update readme --- README.md | 238 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 122 insertions(+), 116 deletions(-) diff --git a/README.md b/README.md index 1fd3f2a149a..96f85fad8cb 100644 --- a/README.md +++ b/README.md @@ -1,152 +1,158 @@ -# Superset + -A modern monorepo for Superset - featuring a website, desktop app, docs, and blog. +
+header image +

Superset

+

+ The last developer tool you'll ever need +
+ Explore the docs » +
+

-## Quick Start + + + -```bash -# Install dependencies -bun install +[![Twitter][twitter-shield]][twitter-url] -# Start development servers -bun dev +
-# Run tests -bun test -``` +# The Last Developer Tool You'll Ever Need -## Tech Stack +Superset helps you run 100 CLI coding agents on your machine without losing your mind. -- **Package Manager**: Bun -- **Build System**: Turborepo -- **Database**: Drizzle ORM + Neon PostgreSQL -- **UI**: React + TailwindCSS v4 + shadcn/ui -- **Code Quality**: Biome (formatting + linting) -## Project Structure +## What you can do with Superset: -``` -apps/ -├── website/ # Main website application -├── desktop/ # Electron desktop app -├── cli/ # Command-line interface for managing workspaces & agents -├── docs/ # Documentation site -└── blog/ # Blog site +- [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 -packages/ -├── ui/ # Shared UI components (shadcn/ui) -├── db/ # Drizzle ORM database schema -├── constants/ # Shared constants -├── models/ # Shared data models -├── scripts/ # CLI tooling -└── typescript-config/ # TypeScript configurations -``` +![Superset-GitHub-Example](https://github.com/user-attachments/assets/642de37a-72cc-4056-8eb7-8eb42714cdc4) -## Development +## Getting Started -### Common Commands +[Download the app](https://superset.sh) or +[run locally](https://superset.sh). -```bash -# Development -bun dev # Start all dev servers -bun test # Run tests -bun build # Build all packages - -# Code Quality -bun run lint # Format + lint + fix auto-fixable issues -bun run lint:check # Check only (no changes, for CI) -bun run format # Format code only -bun run format:check # Check formatting only (CI) -bun run typecheck # Type check all packages - -# Database -bun run db:push # Apply schema changes -bun run db:seed # Seed database -bun run db:migrate # Run migrations -bun run db:studio # Open Drizzle Studio - -# Maintenance -bun run clean # Clean root node_modules -bun run clean:workspaces # Clean all workspace node_modules -``` - -### Adding UI Components - -```bash -cd packages/ui -npx shadcn@latest add -``` - -## Code Quality - -This project uses Biome for formatting and linting (configured at root level): +### Usage -- **Format + Lint**: `bun run lint` - Automatically fixes issues -- **Check Only**: `bun run lint:check` - Validates without changes (CI) +Superset creates a new workspace for each of your tasks. Each workspace is isolated and parallel. -## Database +image -Schema is defined in `packages/db/src/` using Drizzle ORM. +
-### Migrations +We automatically set up your workspace by cloning env variables, installing dependencies, etc. -1. Spin up a new Neon branch for migrations -2. Update root `.env` to point at the Neon branch -3. Modify Drizzle schema in `packages/db/src/schema` -4. Generate migration: `pnpm drizzle-kit generate --name="migration_name_snake_case"` +image -**Neon Details:** -- Org ID: `org-round-base-25422821` -- Project ID: `tiny-cherry-82420694` +
-## CLI Tool +Coding agents can be spun up and organized. They can pass messages between each other ping you when they are done. -The CLI (`apps/cli`) provides terminal-based management of workspaces and agents: +image -### Features +
-- **Workspace Management**: List, create, and switch between workspaces -- **Agent Monitoring**: Track running agents with real-time status updates -- **Interactive Panels**: Navigate workspaces and agents with keyboard shortcuts -- **Process Orchestration**: Manage agent lifecycle (start, stop, attach) +Superset gives you a high level view of all the changes made and help you create and merge a PR in a few clicks -### Usage +image -```bash -# View all commands -superset --help +## Documentation -# Interactive panels view -superset panels +For full documentation, visit [docs.superset.sh](https://docs.superset.sh) -# Dashboard view -superset dashboard +To see how to Contribute, visit +[Contributing to Superset](https://docs.superset.sh/developers) in our docs. -# Agent management -superset agent list -superset agent attach -``` +## How it works -### Requirements +architecture -- Node.js >=20 (required by string-width dependency) +1. Coming soon -## Desktop App +For a full walkthrough, check out our +[Architecture Docs](https://docs.superset.sh/developers/architecture). -The desktop app (`apps/desktop`) is built with Electron and features: +### Our Tech Stack -- Type-safe IPC communication -- Terminal management with node-pty -- Git worktree-based workspace management - -See `apps/desktop/docs/TYPE_SAFE_IPC.md` for IPC documentation. +- [Electron]() +- [React]() ## Contributing -1. Keep diffs minimal and targeted -2. Follow existing code patterns -3. Maintain type safety (avoid `any`) -4. Co-locate components by usage -5. Run `bun run lint` before committing - -For detailed architecture guidelines, see `AGENTS.md`. \ No newline at end of file +![image](https://github.com/user-attachments/assets/ecc94303-df23-46ae-87dc-66b040396e0b) + +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. + +#### Contributors + + + + + +## Contact + +![image](https://github.com/user-attachments/assets/60684b68-1925-4550-8efd-51a1509fc953) + +- Team: + [Twitter](https://twitter.com/superset-sh) - + [Email](mailto:hoakiet98@gmail.com) +- Project: + [https://github.com/superset-sh/superset](https://github.com/superset-sh/superset) +- Website: [https://superset.sh](https://superset.sh) + +## License + +Distributed under the Apache 2.0 License. See [LICENSE.md](LICENSE.md) for more +information. + + + +[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]: https://github.com/superset-sh/superset/blob/master/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 +[weave-shield]: https://img.shields.io/endpoint?url=https%3A%2F%2Fapp.workweave.ai%2Fapi%2Frepository%2Fbadge%2Forg_pWcXBHJo3Li2Te2Y4WkCPA33%2F820087727&cacheSeconds=3600&labelColor=#131313 +[weave-url]: https://app.workweave.ai/reports/repository/org_pWcXBHJo3Li2Te2Y4WkCPA33/820087727 From c7c13feed78261a02c214bd48cdcaa5800782d4b Mon Sep 17 00:00:00 2001 From: Kiet <31864905+Kitenite@users.noreply.github.com> Date: Sun, 23 Nov 2025 13:40:00 -0800 Subject: [PATCH 2/3] update readme Updated README to improve compatibility and add team Twitter links. --- README.md | 47 +++++++++++------------------------------------ 1 file changed, 11 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 96f85fad8cb..9cf8f19c84a 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,15 @@ -
-header image +header image

Superset

The last developer tool you'll ever need -
- Explore the docs » -

- - - - -[![Twitter][twitter-shield]][twitter-url] +[![Superset Twitter](https://img.shields.io/badge/@superset_sh-555?logo=x)](https://x.com/superset_sh)
-# The Last Developer Tool You'll Ever Need - Superset helps you run 100 CLI coding agents on your machine without losing your mind. @@ -43,7 +23,7 @@ Superset helps you run 100 CLI coding agents on your machine without losing your - [ ] Seemlessly transition between local and cloud so you can code on the go - [ ] Automate reviewing and adjusting with minimal input -![Superset-GitHub-Example](https://github.com/user-attachments/assets/642de37a-72cc-4056-8eb7-8eb42714cdc4) +example-min ## Getting Started @@ -83,8 +63,6 @@ To see how to Contribute, visit ## How it works -architecture - 1. Coming soon For a full walkthrough, check out our @@ -97,8 +75,6 @@ For a full walkthrough, check out our ## Contributing -![image](https://github.com/user-attachments/assets/ecc94303-df23-46ae-87dc-66b040396e0b) - 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). @@ -111,16 +87,11 @@ See the [CONTRIBUTING.md](CONTRIBUTING.md) for instructions and code of conduct. -## Contact - -![image](https://github.com/user-attachments/assets/60684b68-1925-4550-8efd-51a1509fc953) +## Team +- [![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) -- Team: - [Twitter](https://twitter.com/superset-sh) - - [Email](mailto:hoakiet98@gmail.com) -- Project: - [https://github.com/superset-sh/superset](https://github.com/superset-sh/superset) -- Website: [https://superset.sh](https://superset.sh) ## License @@ -129,6 +100,10 @@ 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 From a024f205b985ceb77df5c13b3f0fa0634ce3afdf Mon Sep 17 00:00:00 2001 From: Kiet Ho Date: Sun, 23 Nov 2025 13:45:41 -0800 Subject: [PATCH 3/3] finish readme --- CONTRIBUTING.md | 1 + README.md | 39 +++++++++++++++++---------------------- 2 files changed, 18 insertions(+), 22 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000000..fe4d5d354be --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1 @@ +Coming soon \ No newline at end of file diff --git a/README.md b/README.md index 9cf8f19c84a..45708db13cb 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ Superset helps you run 100 CLI coding agents on your machine without losing your - [ ] Seemlessly transition between local and cloud so you can code on the go - [ ] Automate reviewing and adjusting with minimal input -example-min +example-min ## Getting Started @@ -34,44 +34,39 @@ Superset helps you run 100 CLI coding agents on your machine without losing your Superset creates a new workspace for each of your tasks. Each workspace is isolated and parallel. -image - +
We automatically set up your workspace by cloning env variables, installing dependencies, etc. -image +
Coding agents can be spun up and organized. They can pass messages between each other ping you when they are done. -image +
Superset gives you a high level view of all the changes made and help you create and merge a PR in a few clicks -image - -## Documentation - -For full documentation, visit [docs.superset.sh](https://docs.superset.sh) - -To see how to Contribute, visit -[Contributing to Superset](https://docs.superset.sh/developers) in our docs. - -## How it works - -1. Coming soon - -For a full walkthrough, check out our -[Architecture Docs](https://docs.superset.sh/developers/architecture). + ### Our Tech Stack -- [Electron]() -- [React]() +[![Bun](https://img.shields.io/badge/Bun-000000?logo=bun&logoColor=white)](https://bun.sh/) +[![Turborepo](https://img.shields.io/badge/Turborepo-EF4444?logo=turborepo&logoColor=white)](https://turbo.build/) +[![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/) +[![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?logo=typescript&logoColor=white)](https://www.typescriptlang.org/) +[![Vite](https://img.shields.io/badge/vite-%23646CFF.svg?logo=vite&logoColor=white)](https://vitejs.dev/) +[![TailwindCSS](https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?logo=tailwind-css&logoColor=white)](https://tailwindcss.com/) +[![Drizzle ORM](https://img.shields.io/badge/Drizzle%20ORM-FFE873?logo=drizzle&logoColor=black)](https://orm.drizzle.team/) +[![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/) +[![Biome](https://img.shields.io/badge/Biome-339AF0?logo=biome&logoColor=white)](https://biomejs.dev/) +[![shadcn/ui](https://img.shields.io/badge/shadcn%2Fui-000000?logo=shadcnui&logoColor=white)](https://ui.shadcn.com/) ## Contributing