diff --git a/README.md b/README.md index 90246943df1..cd77178afb7 100644 --- a/README.md +++ b/README.md @@ -1,85 +1,54 @@

- - - - - Sim Logo - - -

- -

The open-source AI workspace where teams build, deploy, and manage AI agents. Build conversationally, visually, or with code. Connect 1,000+ integrations and every major LLM to automate real work.

- -

- Sim.ai - Discord - Twitter - Documentation -

- -

- Ask DeepWiki Set Up with Cursor -

- -### Build everything in Chat -Your AI command center. Describe what you want in plain language. Sim knows your entire workspace and takes action: building agents, running them, querying data, and more. - -

- Sim building and running an agent from chat -

- -### Create files and documents -Generate documents, reports, and presentations from a single prompt, grounded in your workspace data. - -

- Sim generating a document from a prompt + Sim.ai + Documentation + Discord + X

-### Ground agents in your knowledge -Upload documents to a knowledge base and let agents answer questions from your own content. -

- Creating a knowledge base + Ask DeepWiki + Set Up with Cursor

-### Structured data with Tables -A database, built in. Store, query, and wire structured data into agent runs. -

- Tables view with typed columns + + Sim — your workflow agent for solving automations. Build, deploy, and manage AI agents visually, conversationally, or with code. +

-### Build visually with Workflows -Prefer a canvas? Design agents block by block in the visual builder, and let Sim generate blocks, wire variables, and fix errors from natural language. - -

- Workflow builder demo -

+

A workspace to build, deploy and manage AI agents and workflows.

## Quickstart ### Cloud-hosted: [sim.ai](https://sim.ai) -Sim.ai +Open sim.ai -### Self-hosted: NPM Package +### Self-hosted ```bash npx simstudio ``` -→ http://localhost:3000 -#### Note -Docker must be installed and running on your machine. +Open [http://localhost:3000](http://localhost:3000) + +Docker must be installed and running. Use `-p, --port ` to run Sim on a different port, or `--no-pull` to skip pulling the latest Docker images. + +

+ How Sim works — Integrate, Ingest, Build, Monitor — shown end to end: start a chat to build an agent, connect Slack and other integrations, add a knowledge base, build the workflow visually, deploy it, and monitor runs in the logs +

+ +## Capabilities -#### Options +- Connect 1,000+ integrations and every major LLM +- Add Slack, Notion, HubSpot, Salesforce, databases, and more +- Build agents visually, conversationally, or with code +- Ingest files, knowledge bases, and structured table data +- Monitor runs, logs, schedules, and workflow activity -| Flag | Description | -|------|-------------| -| `-p, --port ` | Port to run Sim on (default `3000`) | -| `--no-pull` | Skip pulling latest Docker images | +## Self-hosting -### Self-hosted: Docker Compose +### Docker Compose ```bash git clone https://github.com/simstudioai/sim.git && cd sim @@ -90,7 +59,7 @@ Open [http://localhost:3000](http://localhost:3000) Sim also supports local models via [Ollama](https://ollama.ai) and [vLLM](https://docs.vllm.ai/). See the [Docker self-hosting docs](https://docs.sim.ai/self-hosting/docker) for setup details. -### Self-hosted: Manual Setup +### Manual Setup **Requirements:** [Bun](https://bun.sh/), [Node.js](https://nodejs.org/) v20+, PostgreSQL 12+ with [pgvector](https://github.com/pgvector/pgvector) @@ -175,4 +144,6 @@ 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

+

+ Built by the Sim team in San Francisco +

diff --git a/apps/sim/public/logo/readme-logotype-dark.svg b/apps/sim/public/logo/readme-logotype-dark.svg new file mode 100644 index 00000000000..40379c53a85 --- /dev/null +++ b/apps/sim/public/logo/readme-logotype-dark.svg @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/apps/sim/public/static/readme-built-by-sim-team.png b/apps/sim/public/static/readme-built-by-sim-team.png new file mode 100644 index 00000000000..8e8bd4c38f8 Binary files /dev/null and b/apps/sim/public/static/readme-built-by-sim-team.png differ diff --git a/apps/sim/public/static/readme-feature-row.svg b/apps/sim/public/static/readme-feature-row.svg new file mode 100644 index 00000000000..f7808b0b387 --- /dev/null +++ b/apps/sim/public/static/readme-feature-row.svg @@ -0,0 +1,920 @@ + + Sim feature areas + Four feature illustrations labeled Integrate, Ingest, Build, and Monitor. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Integrate + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Ingest + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Build + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Monitor + + diff --git a/apps/sim/public/static/readme-hero.gif b/apps/sim/public/static/readme-hero.gif new file mode 100644 index 00000000000..a652ca1ebd9 Binary files /dev/null and b/apps/sim/public/static/readme-hero.gif differ diff --git a/apps/sim/public/static/readme-tour.gif b/apps/sim/public/static/readme-tour.gif new file mode 100644 index 00000000000..67bd16890ea Binary files /dev/null and b/apps/sim/public/static/readme-tour.gif differ