From a751f502bb5fe8b2d10c921a3aa54ee6c6ee53e6 Mon Sep 17 00:00:00 2001 From: Vikhyath Mondreti Date: Sat, 18 Apr 2026 02:37:24 -0700 Subject: [PATCH 1/2] chore(readme): update tech stack section --- README.md | 76 +++++++++++++++++++++++-------------------------------- 1 file changed, 32 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index de6befd2a8f..a227b5b7927 100644 --- a/README.md +++ b/README.md @@ -1,69 +1,55 @@ -

- - - - - Sim Logo - - -

- -

The open-source platform to build AI agents and run your agentic workforce. Connect 1,000+ integrations and LLMs to orchestrate agentic workflows.

- -

- Sim.ai - Discord - Twitter - Documentation -

- -

- Ask DeepWiki Set Up with Cursor -

+ + +The open-source platform to build AI agents and run your agentic workforce. Connect 1,000+ integrations and LLMs to orchestrate agentic workflows. + + + + ### Build Workflows with Ease + Design agent workflows visually on a canvas—connect agents, tools, and blocks, then run them instantly. -

- Workflow Builder Demo -

+ ### Supercharge with Copilot + Leverage Copilot to generate nodes, fix errors, and iterate on flows directly from natural language. -

- Copilot Demo -

+ ### Integrate Vector Databases + Upload documents to a vector store and let agents answer questions grounded in your specific content. -

- Knowledge Uploads and Retrieval Demo -

+ ## Quickstart ### Cloud-hosted: [sim.ai](https://sim.ai) -Sim.ai + ### Self-hosted: NPM Package ```bash npx simstudio ``` -→ http://localhost:3000 + +→ [http://localhost:3000](http://localhost:3000) #### Note + Docker must be installed and running on your machine. #### Options -| Flag | Description | -|------|-------------| + +| Flag | Description | +| ------------------- | ----------------------------------- | | `-p, --port ` | Port to run Sim on (default `3000`) | -| `--no-pull` | Skip pulling latest Docker images | +| `--no-pull` | Skip pulling latest Docker images | + ### Self-hosted: Docker Compose @@ -89,7 +75,7 @@ bun install bun run prepare # Set up pre-commit hooks ``` -2. Set up PostgreSQL with pgvector: +1. Set up PostgreSQL with pgvector: ```bash docker run --name simstudio-db -e POSTGRES_PASSWORD=your_password -e POSTGRES_DB=simstudio -p 5432:5432 -d pgvector/pgvector:pg17 @@ -97,7 +83,7 @@ docker run --name simstudio-db -e POSTGRES_PASSWORD=your_password -e POSTGRES_DB Or install manually via the [pgvector guide](https://github.com/pgvector/pgvector#installation). -3. Configure environment: +1. Configure environment: ```bash cp apps/sim/.env.example apps/sim/.env @@ -110,13 +96,13 @@ cp packages/db/.env.example packages/db/.env # Edit both .env files to set DATABASE_URL="postgresql://postgres:your_password@localhost:5432/simstudio" ``` -4. Run migrations: +1. Run migrations: ```bash cd packages/db && bun run db:migrate ``` -5. Start development servers: +1. Start development servers: ```bash bun run dev:full # Starts Next.js app and realtime socket server @@ -128,12 +114,12 @@ Or run separately: `bun run dev` (Next.js) and `cd apps/sim && bun run dev:socke Copilot is a Sim-managed service. To use Copilot on a self-hosted instance: -- Go to https://sim.ai → Settings → Copilot and generate a Copilot API key +- Go to [https://sim.ai](https://sim.ai) → Settings → Copilot and generate a Copilot API key - Set `COPILOT_API_KEY` environment variable in your self-hosted apps/sim/.env file to that value ## Environment Variables -See the [environment variables reference](https://docs.sim.ai/self-hosting/environment-variables) for the full list, or [`apps/sim/.env.example`](apps/sim/.env.example) for defaults. +See the [environment variables reference](https://docs.sim.ai/self-hosting/environment-variables) for the full list, or `[apps/sim/.env.example](apps/sim/.env.example)` for defaults. ## Tech Stack @@ -142,13 +128,15 @@ See the [environment variables reference](https://docs.sim.ai/self-hosting/envir - **Database**: PostgreSQL with [Drizzle ORM](https://orm.drizzle.team) - **Authentication**: [Better Auth](https://better-auth.com) - **UI**: [Shadcn](https://ui.shadcn.com/), [Tailwind CSS](https://tailwindcss.com) -- **State Management**: [Zustand](https://zustand-demo.pmnd.rs/) +- **Streaming Markdown**: [Streamdown](https://github.com/vercel/streamdown) +- **State Management**: [Zustand](https://zustand-demo.pmnd.rs/), [TanStack Query](https://tanstack.com/query) - **Flow Editor**: [ReactFlow](https://reactflow.dev/) - **Docs**: [Fumadocs](https://fumadocs.vercel.app/) - **Monorepo**: [Turborepo](https://turborepo.org/) - **Realtime**: [Socket.io](https://socket.io/) - **Background Jobs**: [Trigger.dev](https://trigger.dev/) - **Remote Code Execution**: [E2B](https://www.e2b.dev/) +- **Isolated Code Execution**: [isolated-vm](https://github.com/laverdet/isolated-vm) ## Contributing @@ -158,4 +146,4 @@ We welcome contributions! Please see our [Contributing Guide](.github/CONTRIBUTI This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details. -

Made with ❤️ by the Sim Team

+Made with ❤️ by the Sim Team \ No newline at end of file From fd2dda39e16750711b3ae17d2a31f11afe272f85 Mon Sep 17 00:00:00 2001 From: Vikhyath Mondreti Date: Sat, 18 Apr 2026 02:41:54 -0700 Subject: [PATCH 2/2] fix --- README.md | 72 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 43 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index a227b5b7927..57c0192825e 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,69 @@ - - -The open-source platform to build AI agents and run your agentic workforce. Connect 1,000+ integrations and LLMs to orchestrate agentic workflows. - - - - +

+ + + + + Sim Logo + + +

+ +

The open-source platform to build AI agents and run your agentic workforce. Connect 1,000+ integrations and LLMs to orchestrate agentic workflows.

+ +

+ Sim.ai + Discord + Twitter + Documentation +

+ +

+ Ask DeepWiki Set Up with Cursor +

### Build Workflows with Ease - Design agent workflows visually on a canvas—connect agents, tools, and blocks, then run them instantly. - +

+ Workflow Builder Demo +

### Supercharge with Copilot - Leverage Copilot to generate nodes, fix errors, and iterate on flows directly from natural language. - +

+ Copilot Demo +

### Integrate Vector Databases - Upload documents to a vector store and let agents answer questions grounded in your specific content. - +

+ Knowledge Uploads and Retrieval Demo +

## Quickstart ### Cloud-hosted: [sim.ai](https://sim.ai) - +Sim.ai ### Self-hosted: NPM Package ```bash npx simstudio ``` - -→ [http://localhost:3000](http://localhost:3000) +→ http://localhost:3000 #### Note - Docker must be installed and running on your machine. #### Options - -| Flag | Description | -| ------------------- | ----------------------------------- | +| Flag | Description | +|------|-------------| | `-p, --port ` | Port to run Sim on (default `3000`) | -| `--no-pull` | Skip pulling latest Docker images | - +| `--no-pull` | Skip pulling latest Docker images | ### Self-hosted: Docker Compose @@ -75,7 +89,7 @@ bun install bun run prepare # Set up pre-commit hooks ``` -1. Set up PostgreSQL with pgvector: +2. Set up PostgreSQL with pgvector: ```bash docker run --name simstudio-db -e POSTGRES_PASSWORD=your_password -e POSTGRES_DB=simstudio -p 5432:5432 -d pgvector/pgvector:pg17 @@ -83,7 +97,7 @@ docker run --name simstudio-db -e POSTGRES_PASSWORD=your_password -e POSTGRES_DB Or install manually via the [pgvector guide](https://github.com/pgvector/pgvector#installation). -1. Configure environment: +3. Configure environment: ```bash cp apps/sim/.env.example apps/sim/.env @@ -96,13 +110,13 @@ cp packages/db/.env.example packages/db/.env # Edit both .env files to set DATABASE_URL="postgresql://postgres:your_password@localhost:5432/simstudio" ``` -1. Run migrations: +4. Run migrations: ```bash cd packages/db && bun run db:migrate ``` -1. Start development servers: +5. Start development servers: ```bash bun run dev:full # Starts Next.js app and realtime socket server @@ -114,12 +128,12 @@ Or run separately: `bun run dev` (Next.js) and `cd apps/sim && bun run dev:socke Copilot is a Sim-managed service. To use Copilot on a self-hosted instance: -- Go to [https://sim.ai](https://sim.ai) → Settings → Copilot and generate a Copilot API key +- Go to https://sim.ai → Settings → Copilot and generate a Copilot API key - Set `COPILOT_API_KEY` environment variable in your self-hosted apps/sim/.env file to that value ## Environment Variables -See the [environment variables reference](https://docs.sim.ai/self-hosting/environment-variables) for the full list, or `[apps/sim/.env.example](apps/sim/.env.example)` for defaults. +See the [environment variables reference](https://docs.sim.ai/self-hosting/environment-variables) for the full list, or [`apps/sim/.env.example`](apps/sim/.env.example) for defaults. ## Tech Stack @@ -146,4 +160,4 @@ We welcome contributions! Please see our [Contributing Guide](.github/CONTRIBUTI This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details. -Made with ❤️ by the Sim Team \ No newline at end of file +

Made with ❤️ by the Sim Team