Skip to content

README.md

Latest commit

 

History

History
240 lines (173 loc) · 14.1 KB

README.md

File metadata and controls

240 lines (173 loc) · 14.1 KB

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

Sim.ai

Self-hosted: NPM Package

npx simstudio

→ http://localhost:3000

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

Open http://localhost:3000

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

  1. Clone and install:
git clone https://github.com/simstudioai/sim.git
cd sim
bun install
bun run prepare  # Set up pre-commit hooks
  1. 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.

  1. 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"
  1. Run migrations:
cd packages/db && bun run db:migrate
  1. 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_KEY environment 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

Frequently Asked Questions (FAQ)

General Questions

Q: What is Sim?
A: Sim is an open-source platform to build AI agents and run your agentic workforce. It provides a visual workflow builder, 1,000+ integrations, and support for multiple LLMs to orchestrate agentic workflows.

Q: Is Sim free to use?
A: Yes, Sim is open-source (Apache 2.0 license). You can self-host it for free or use the cloud-hosted version at sim.ai.

Q: What's the difference between self-hosted and cloud?
A:

  • Cloud (sim.ai): Managed service with automatic updates, scaling, and support
  • Self-hosted: Full control over your data and infrastructure, requires your own resources

Q: Which AI models does Sim support?
A: Sim supports all major LLM providers including OpenAI, Anthropic, Google, and local models via Ollama and vLLM. See the documentation for the complete list.

Installation & Setup

Q: What are the requirements for self-hosting?
A:

  • Docker method: Docker and Docker Compose installed, 12GB+ RAM recommended
  • Manual method: Bun, Node.js v20+, PostgreSQL 12+ with pgvector extension

Q: How do I install Sim?
A: The easiest way is using the NPM package:

npx simstudio

Or with Docker Compose:

git clone https://github.com/simstudioai/sim.git && cd sim
docker compose -f docker-compose.prod.yml up -d

Q: Can I use local AI models?
A: Yes! Sim supports local models via Ollama and vLLM. See the Docker self-hosting docs for setup details.

Q: How do I enable Copilot in self-hosted instances?
A: Copilot is a Sim-managed service. Generate a Copilot API key at https://sim.ai → Settings → Copilot, then set COPILOT_API_KEY in your .env file.

Troubleshooting

Port already in use errors

  • Default ports: 3000 (app), 3002 (sockets), 5432 (PostgreSQL)
  • Change ports in docker-compose.yml or stop conflicting services
  • Check with: lsof -i :3000 or docker ps

Docker containers not starting

  • Ensure Docker daemon is running: docker info
  • Check available memory: Sim needs 12GB+ RAM
  • View logs: docker compose -f docker-compose.prod.yml logs

Database connection errors

  • Verify PostgreSQL is running with pgvector extension
  • Check connection string in .env file
  • For Docker: ensure the db container is healthy before starting app

Workflow not executing

  • Check that all required API keys are configured
  • Verify node connections in the workflow builder
  • Review logs in the Sim dashboard or Docker logs

Copilot not working

  • Ensure COPILOT_API_KEY is set correctly in .env
  • Verify the key is valid (generate new one if needed)
  • Check network connectivity to sim.ai

Getting More Help

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