-
Notifications
You must be signed in to change notification settings - Fork 897
readme #133
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.
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
readme #133
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Coming soon |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,152 +1,128 @@ | ||||||
| # Superset | ||||||
| <!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 --> | ||||||
| <div align="center"> | ||||||
| <img width="600" alt="header image" src="apps/website/public/title.svg"> | ||||||
| <h3 align="center">Superset</h3> | ||||||
| <p align="center"> | ||||||
| The last developer tool you'll ever need | ||||||
| </p> | ||||||
|
|
||||||
| A modern monorepo for Superset - featuring a website, desktop app, docs, and blog. | ||||||
| [](https://x.com/superset_sh) | ||||||
|
|
||||||
| ## Quick Start | ||||||
| </div> | ||||||
|
|
||||||
| ```bash | ||||||
| # Install dependencies | ||||||
| bun install | ||||||
| Superset helps you run 100 CLI coding agents on your machine without losing your mind. | ||||||
|
|
||||||
| # Start development servers | ||||||
| bun dev | ||||||
|
|
||||||
| # Run tests | ||||||
| bun test | ||||||
| ``` | ||||||
| ## What you can do with Superset: | ||||||
|
|
||||||
| ## Tech Stack | ||||||
| - [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 | ||||||
|
|
||||||
| - **Package Manager**: Bun | ||||||
| - **Build System**: Turborepo | ||||||
| - **Database**: Drizzle ORM + Neon PostgreSQL | ||||||
| - **UI**: React + TailwindCSS v4 + shadcn/ui | ||||||
| - **Code Quality**: Biome (formatting + linting) | ||||||
| <img alt="example-min" src="https://github.com/user-attachments/assets/9db68082-47f4-4076-92a0-85ac97572699" /> | ||||||
|
|
||||||
| ## Project Structure | ||||||
| ## Getting Started | ||||||
|
|
||||||
| ``` | ||||||
| apps/ | ||||||
| ├── website/ # Main website application | ||||||
| ├── desktop/ # Electron desktop app | ||||||
| ├── cli/ # Command-line interface for managing workspaces & agents | ||||||
| ├── docs/ # Documentation site | ||||||
| └── blog/ # Blog site | ||||||
| [Download the app](https://superset.sh) or | ||||||
| [run locally](https://superset.sh). | ||||||
|
|
||||||
| 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 | ||||||
| ``` | ||||||
|
|
||||||
| ## Development | ||||||
|
|
||||||
| ### Common Commands | ||||||
|
|
||||||
| ```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 <component> | ||||||
| ``` | ||||||
|
|
||||||
| ## Code Quality | ||||||
|
|
||||||
| This project uses Biome for formatting and linting (configured at root level): | ||||||
|
|
||||||
| - **Format + Lint**: `bun run lint` - Automatically fixes issues | ||||||
| - **Check Only**: `bun run lint:check` - Validates without changes (CI) | ||||||
|
|
||||||
| ## Database | ||||||
|
|
||||||
| Schema is defined in `packages/db/src/` using Drizzle ORM. | ||||||
|
|
||||||
| ### Migrations | ||||||
|
|
||||||
| 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"` | ||||||
|
|
||||||
| **Neon Details:** | ||||||
| - Org ID: `org-round-base-25422821` | ||||||
| - Project ID: `tiny-cherry-82420694` | ||||||
|
|
||||||
| ## CLI Tool | ||||||
|
|
||||||
| The CLI (`apps/cli`) provides terminal-based management of workspaces and agents: | ||||||
| ### Usage | ||||||
|
|
||||||
| ### Features | ||||||
| Superset creates a new workspace for each of your tasks. Each workspace is isolated and parallel. | ||||||
|
|
||||||
| - **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) | ||||||
| <!-- [TODO: Add Image] --> | ||||||
| <br> | ||||||
|
|
||||||
| ### Usage | ||||||
| We automatically set up your workspace by cloning env variables, installing dependencies, etc. | ||||||
|
|
||||||
| ```bash | ||||||
| # View all commands | ||||||
| superset --help | ||||||
| <!-- [TODO: Add Image] --> | ||||||
|
|
||||||
| # Interactive panels view | ||||||
| superset panels | ||||||
| <br> | ||||||
|
|
||||||
| # Dashboard view | ||||||
| superset dashboard | ||||||
| Coding agents can be spun up and organized. They can pass messages between each other ping you when they are done. | ||||||
|
|
||||||
| # Agent management | ||||||
| superset agent list | ||||||
| superset agent attach <agent-id> | ||||||
| ``` | ||||||
| <!-- [TODO: Add Image] --> | ||||||
|
|
||||||
| ### Requirements | ||||||
| <br> | ||||||
|
|
||||||
| - Node.js >=20 (required by string-width dependency) | ||||||
| Superset gives you a high level view of all the changes made and help you create and merge a PR in a few clicks | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add hyphenation to compound adjective. Line 73 contains the phrase "high level view", which should be hyphenated as "high-level view" when used as a compound adjective before the noun. Apply this diff: -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 gives you a high-level view of all the changes made and help you create and merge a PR in a few clicks📝 Committable suggestion
Suggested change
🧰 Tools🪛 LanguageTool[grammar] ~73-~73: Use a hyphen to join words. (QB_NEW_EN_HYPHEN) 🤖 Prompt for AI Agents |
||||||
|
|
||||||
| ## Desktop App | ||||||
| <!-- [TODO: Add Image] --> | ||||||
|
|
||||||
| 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. | ||||||
| [](https://bun.sh/) | ||||||
| [](https://turbo.build/) | ||||||
| [](https://www.electronjs.org/) | ||||||
| [](https://reactjs.org/) | ||||||
| [](https://www.typescriptlang.org/) | ||||||
| [](https://vitejs.dev/) | ||||||
| [](https://tailwindcss.com/) | ||||||
| [](https://orm.drizzle.team/) | ||||||
| [](https://neon.tech/) | ||||||
| [](https://trpc.io/) | ||||||
| [](https://biomejs.dev/) | ||||||
| [](https://ui.shadcn.com/) | ||||||
|
|
||||||
| ## 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`. | ||||||
| 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 | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fix heading level increment. Line 108 uses an h4 ( Apply this diff to fix the heading level: -#### Contributors
+### Contributors📝 Committable suggestion
Suggested change
🧰 Tools🪛 markdownlint-cli2 (0.18.1)108-108: Heading levels should only increment by one level at a time (MD001, heading-increment) 🤖 Prompt for AI Agents |
||||||
|
|
||||||
| <a href="https://github.com/superset-sh/superset/graphs/contributors"> | ||||||
| <img src="https://contrib.rocks/image?repo=superset-sh/superset" /> | ||||||
|
coderabbitai[bot] marked this conversation as resolved.
|
||||||
| </a> | ||||||
|
|
||||||
| ## Team | ||||||
| - [](https://x.com/flyakiet) | ||||||
| - [](https://x.com/saddle_paddle) | ||||||
| - [](https://x.com/avimakesrobots) | ||||||
|
|
||||||
|
|
||||||
| ## 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]: 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 | ||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix spelling error.
Line 43 contains a spelling error: "Seemlessly" should be "Seamlessly".
Apply this diff:
📝 Committable suggestion
🧰 Tools
🪛 LanguageTool
[grammar] ~43-~43: Ensure spelling is correct
Context: ...d clone your standard environment - [ ] Seemlessly transition between local and cloud so y...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents