mirror of
https://github.com/simstudioai/sim.git
synced 2026-02-19 02:34:37 -05:00
1.6 KiB
1.6 KiB
Sim Cloud Agent Guide
Project Overview
Sim is an AI agent workflow builder. Turborepo monorepo with Bun workspaces.
Services
| Service | Port | Command |
|---|---|---|
| Next.js App | 3000 | bun run dev (from root) |
| Realtime Socket Server | 3002 | cd apps/sim && bun run dev:sockets |
| Both together | 3000+3002 | bun run dev:full (from root) |
| Docs site | 3001 | cd apps/docs && bun run dev |
| PostgreSQL (pgvector) | 5432 | Docker container simstudio-db |
Common Commands
- Lint:
bun run lint:check(read-only) orbun run lint(auto-fix) - Format:
bun run format:check(read-only) orbun run format(auto-fix) - Test:
bun run test(all packages via turborepo) - Test single app:
cd apps/sim && bunx vitest run - Type check:
bun run type-check - Dev:
bun run dev:full(Next.js app + realtime socket server) - DB migrations:
cd packages/db && bunx drizzle-kit migrate --config=./drizzle.config.ts
Architecture Notes
- Package manager is bun (not npm/npx). Use
bunandbunx. - Linter/formatter is Biome (not ESLint/Prettier).
- Testing framework is Vitest with
@sim/testingfor shared mocks/factories. - Database uses Drizzle ORM with PostgreSQL + pgvector.
- Auth is Better Auth (session cookies).
- Pre-commit hook runs
bunx lint-stagedwhich appliesbiome check --write. .npmrchasignore-scripts=true.- Docs app requires
fumadocs-mdxgeneration before type-check (bunx fumadocs-mdxinapps/docs/). - Coding guidelines are in
CLAUDE.md(root) and.cursor/rules/*.mdc. - See
.github/CONTRIBUTING.mdfor contribution workflow details.