mirror of
https://github.com/simstudioai/sim.git
synced 2026-09-24 15:45:35 +08:00
Waleed
d60747d4b7
* feat(mothership): draft persistence, new task eager creation, doc preview fix, and loading polish - Add `useMothershipDraftsStore` (persist) to save and restore draft text, file attachments, and contexts per chat scope key; cleared on workspace reset - Add `useCreateTask` mutation that eagerly POSTs a new chat, optimistically prepends it to the sidebar task list, and navigates to `/task/:id` — removes the `id:'new'` placeholder pattern entirely - Fix docx/pptx/pdf preview: remove `!isDocFormat` guards in `file-preview-adapter` so preview sessions are created and streaming content is set during agent writes, suppressing intermediate compilation errors - Replace `Loader2` (lucide) with `Loader` (emcn) across auth, chat, knowledge, logs, deploy, and tool-input components; add `Clipboard` icon to emcn - Add `EditorContextMenu` to the Monaco file viewer - Expand Monaco `SIM_DARK` and `SIM_LIGHT` token rules with string.link, delimiter, tag, attribute, and Markdown tokens (strong, emphasis, variable) * fix(files): dispose onContextMenu listener and handle clipboard rejection * fix(tasks): clear workspaceId:new draft after eager task creation * fix(user-input): always update prevDefaultValueRef on defaultValue change Prevents stale ref when defaultValue transitions through empty — if defaultValue goes non-empty → empty → same non-empty value, the ref was not updated on the empty transition, causing setValue to be skipped on the subsequent change. Also removes unnecessary useCallback wrapping from handleSendQueuedHead, handleEditQueued, handleEditQueuedTail in MothershipChat — none have a reference observer (UserInput stores them via refs, QueuedMessages is not React.memo-wrapped). * fix(files): improve light mode number token contrast to 4.8x * fix(tasks): annotate raw fetch in createChat for boundary check * fix(tasks): use requestJson with createMothershipChatContract instead of raw fetch * fix(cleanup): remove cancelQueries from onSuccess, remove redundant Scissors className * fix(tasks): guard handleNewTask against concurrent calls via ref lock * fix(drafts): guard save effect against first-render race that wipes file-only drafts On mount the save effect fired before the restore effect's setState calls propagated, so fileAttachments and contexts were still empty. For a draft with files but no text this caused isEmpty() to return true and setDraft to delete the entry. Added isFirstSaveRef to skip the initial run; the restore triggers a re-render that fires the save with the full, correct payload. * fix(files): only show loading skeleton while fetching, relax mongo auth validation - files.tsx: gate loading skeleton on isLoading so navigating to a missing file ID doesn't permanently show the skeleton after load completes - database-tools.ts: remove refine() pairing username+password on mongo connection schema so either field can be provided independently * revert(database-tools): restore mongo username+password paired validation
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.
Supercharge with Copilot
Leverage Copilot to generate nodes, fix errors, and iterate on flows directly from natural language.
Integrate Vector Databases
Upload documents to a vector store and let agents answer questions grounded in your specific content.
Quickstart
Cloud-hosted: sim.ai
Self-hosted: NPM Package
npx simstudio
Note
Docker must be installed and running on your machine.
Options
| Flag | Description |
|---|---|
-p, --port <port> |
Port to run Sim on (default 3000) |
--no-pull |
Skip pulling latest Docker images |
Self-hosted: Docker Compose
git clone https://github.com/simstudioai/sim.git && cd sim
docker compose -f docker-compose.prod.yml up -d
Sim also supports local models via Ollama and vLLM — see the Docker self-hosting docs for setup details.
Self-hosted: Manual Setup
Requirements: Bun, Node.js v20+, PostgreSQL 12+ with pgvector
- Clone and install:
git clone https://github.com/simstudioai/sim.git
cd sim
bun install
bun run prepare # Set up pre-commit hooks
- Set up PostgreSQL with pgvector:
docker run --name simstudio-db -e POSTGRES_PASSWORD=your_password -e POSTGRES_DB=simstudio -p 5432:5432 -d pgvector/pgvector:pg17
Or install manually via the pgvector guide.
- Configure environment:
cp apps/sim/.env.example apps/sim/.env
# Create your secrets
perl -i -pe "s/your_encryption_key/$(openssl rand -hex 32)/" apps/sim/.env
perl -i -pe "s/your_internal_api_secret/$(openssl rand -hex 32)/" apps/sim/.env
perl -i -pe "s/your_api_encryption_key/$(openssl rand -hex 32)/" apps/sim/.env
# DB configs for migration
cp packages/db/.env.example packages/db/.env
# Edit both .env files to set DATABASE_URL="postgresql://postgres:your_password@localhost:5432/simstudio"
- Run migrations:
cd packages/db && bun run db:migrate
- Start development servers:
bun run dev:full # Starts Next.js app and realtime socket server
Or run separately: bun run dev (Next.js) and cd apps/sim && bun run dev:sockets (realtime).
Copilot API Keys
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
- Set
COPILOT_API_KEYenvironment variable in your self-hosted apps/sim/.env file to that value
Environment Variables
See the environment variables reference for the full list, or apps/sim/.env.example for defaults.
Tech Stack
- Framework: Next.js (App Router)
- Runtime: Bun
- Database: PostgreSQL with Drizzle ORM
- Authentication: Better Auth
- Schema Validation: Zod
- UI: Shadcn, Tailwind CSS
- Streaming Markdown: Streamdown
- State Management: Zustand, TanStack Query
- Flow Editor: ReactFlow
- Docs: Fumadocs
- Monorepo: Turborepo
- Realtime: Socket.io
- Background Jobs: Trigger.dev
- Remote Code Execution: E2B
- Isolated Code Execution: isolated-vm
Contributing
We welcome contributions! Please see our Contributing Guide for details.
License
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
Made with ❤️ by the Sim Team