{"_id":"@_vrsen/openswarm","_rev":"3-ed4d6d9c4d584d4f6abe1c61e7a0f6f6","name":"@_vrsen/openswarm","dist-tags":{"latest":"0.1.2"},"versions":{"0.1.0":{"name":"@_vrsen/openswarm","version":"0.1.0","license":"MIT","_id":"@_vrsen/openswarm@0.1.0","maintainers":[{"name":"_vrsen","email":"me@vrsen.ai"}],"bin":{"openswarm":"bin/openswarm.js"},"dist":{"shasum":"df3a2f1482774557117502cecfcd1aa4291f7d92","tarball":"https://registry.npmjs.org/@_vrsen/openswarm/-/openswarm-0.1.0.tgz","fileCount":316,"integrity":"sha512-w56x9OyQkPaJhL10wq0pSZVf6rdwdasRL19RHCjKA1Fr0D+k2K2XhGVmeG6BvQSi5e6wa78EqbevTKaLQATmzA==","signatures":[{"sig":"MEQCIFtYnZ2JWpWK21QcjpBv/oSDF83hCAYM6VbLIOt11oh5AiBIt3OWZm3bviB1mBaUP3k+Es1EDil91OHDztiECSzCTw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":9321810},"engines":{"node":">=18.0.0","python":">=3.10"},"gitHead":"19056b56118c63ea2e681a56af19fb9603667713","scripts":{"postinstall":"patch-package"},"_npmUser":{"name":"_vrsen","email":"me@vrsen.ai"},"_npmVersion":"10.9.7","description":"An open-source multi-agent AI team built on Agency Swarm","directories":{},"_nodeVersion":"22.22.2","dependencies":{"react":"^18.2.0","sharp":"^0.33.0","pptxgenjs":"^3.12.0","react-dom":"^18.2.0","playwright":"^1.59.1","dom-to-pptx":"^1.1.5","react-icons":"^5.0.0","patch-package":"^8.0.1"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/openswarm_0.1.0_1776166367784_0.11606573343842208","host":"s3://npm-registry-packages-npm-production"}},"0.1.1":{"name":"@_vrsen/openswarm","version":"0.1.1","license":"MIT","_id":"@_vrsen/openswarm@0.1.1","maintainers":[{"name":"_vrsen","email":"me@vrsen.ai"}],"bin":{"openswarm":"bin/openswarm.js"},"dist":{"shasum":"fdf97ead99d51d8ddc4c955bdcd307157548eacf","tarball":"https://registry.npmjs.org/@_vrsen/openswarm/-/openswarm-0.1.1.tgz","fileCount":316,"integrity":"sha512-BbdtdwIqNaKafl0JcL/O1XO7PWKALssEZYmGXlMEzvzJpst4xVUWvRmNyTrs9sRu/RkmhRzDL/sV+QAUX3s5OA==","signatures":[{"sig":"MEQCICdrKOc7zgQvsXIdXqnvx8CpAQiiyqRQbGmwKBkzfL96AiBCy+PM2NmDkgeAc8vKt0R6ID4G2scx/7CsTS+fo90Z2g==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":9321399},"engines":{"node":">=18.0.0","python":">=3.10"},"gitHead":"0b5e325214cae84154e66e8d037d9601389b0ca8","scripts":{"postinstall":"patch-package"},"_npmUser":{"name":"_vrsen","email":"me@vrsen.ai"},"_npmVersion":"10.9.7","description":"An open-source multi-agent AI team built on Agency Swarm","directories":{},"_nodeVersion":"22.22.2","dependencies":{"react":"^18.2.0","sharp":"^0.33.0","pptxgenjs":"^3.12.0","react-dom":"^18.2.0","playwright":"^1.59.1","dom-to-pptx":"^1.1.5","react-icons":"^5.0.0","patch-package":"^8.0.1"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/openswarm_0.1.1_1776172465369_0.5684299572619627","host":"s3://npm-registry-packages-npm-production"}},"0.1.2":{"name":"@_vrsen/openswarm","version":"0.1.2","description":"An open-source multi-agent AI team built on Agency Swarm","license":"MIT","bin":{"openswarm":"bin/openswarm.js"},"scripts":{"postinstall":"patch-package"},"dependencies":{"dom-to-pptx":"^1.1.5","patch-package":"^8.0.1","playwright":"^1.59.1","pptxgenjs":"^3.12.0","react":"^18.2.0","react-dom":"^18.2.0","react-icons":"^5.0.0","sharp":"^0.33.0"},"engines":{"node":">=18.0.0","python":">=3.10"},"_id":"@_vrsen/openswarm@0.1.2","gitHead":"81afd9e3b53156f75091f6789b7778a92370c31a","_nodeVersion":"22.22.2","_npmVersion":"10.9.7","dist":{"integrity":"sha512-MSGbEfKLC231KBl+aFy01G7IncTR1puJigMFNpaPr6a8UHmqmo9mOO3ktSWyWvVxudscmW8PLybJAsM3x/kqGg==","shasum":"26f94687545a19fd04041a45c7bc18ad8a4415f0","tarball":"https://registry.npmjs.org/@_vrsen/openswarm/-/openswarm-0.1.2.tgz","fileCount":316,"unpackedSize":9321348,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDZWqaeE1KZOmXyxDLubBBHIBCodflS48ewnHC478ubSgIhAPAth+jZcDVMoHT6SwuwbEWxbtTNc6KKECVsxdNeQ/ON"}]},"_npmUser":{"name":"_vrsen","email":"me@vrsen.ai"},"directories":{},"maintainers":[{"name":"_vrsen","email":"me@vrsen.ai"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/openswarm_0.1.2_1776174104284_0.44266532778657663"},"_hasShrinkwrap":false}},"time":{"created":"2026-04-14T11:32:47.680Z","modified":"2026-04-14T13:41:44.638Z","0.1.0":"2026-04-14T11:32:48.014Z","0.1.1":"2026-04-14T13:14:25.593Z","0.1.2":"2026-04-14T13:41:44.506Z"},"license":"MIT","description":"An open-source multi-agent AI team built on Agency Swarm","maintainers":[{"name":"_vrsen","email":"me@vrsen.ai"}],"readme":"# OpenSwarm\r\n\r\nOpenSwarm is an **open-source multi-agent AI team** you can run locally (terminal UI) or deploy as an API.\r\n\r\nInstead of a single \"do-everything\" bot, OpenSwarm routes each request to the **right specialist agent** (research, data analysis, docs, slides, images, video, and a virtual assistant) and coordinates the result for you.\r\n\r\nBuilt on [Agency Swarm](https://github.com/VRSEN/agency-swarm) and the [OpenAI Agents SDK](https://github.com/openai/openai-agents-python).\r\n\r\n---\r\n\r\n## What can I do with it?\r\n\r\nExamples you can paste into the terminal UI:\r\n\r\n- \"Research the current competitive landscape for X, cite sources, and summarize in bullets.\"\r\n- \"Analyze `mnt/data.csv`, find anomalies, and produce a chart plus a short narrative.\"\r\n- \"Create a 6-slide pitch deck about X with a modern theme, then export to PPTX.\"\r\n- \"Draft a professional one-page memo about X and export to PDF.\"\r\n- \"Generate a hero image for my landing page, then create 3 variants.\"\r\n- \"Combine these clips, trim pauses, add captions, and export a final video.\"\r\n\r\nOpenSwarm can also connect to external services (Gmail, Slack, GitHub, etc.) via Composio if you set the optional keys.\r\n\r\n---\r\n\r\n## Agent Roster\r\n\r\n| Agent | What it does |\r\n|---|---|\r\n| **Orchestrator** | Routes every user request to the right specialist(s). Never answers directly — pure coordination. |\r\n| **Virtual Assistant** | Handles everyday tasks: writing, scheduling, messaging, task management. Gains 10,000+ external integrations via [Composio](https://composio.dev) (Gmail, Slack, GitHub, HubSpot, and more). |\r\n| **Deep Research** | Conducts comprehensive, evidence-based web research with citations and balanced analysis. |\r\n| **Data Analyst** | Analyses structured data, builds charts, runs statistical models — all inside an isolated IPython kernel. |\r\n| **Slides Agent** | Generates complete, visually polished HTML slide decks, then exports them to PPTX. |\r\n| **Docs Agent** | Creates formatted Word documents and PDFs from outlines or raw content. |\r\n| **Image Generation Agent** | Generates and edits images using Gemini 2.5 Flash Image / Gemini 3 Pro Image and fal.ai. |\r\n| **Video Generation Agent** | Produces videos via Sora (OpenAI), Veo (Google), and Seedance (fal.ai); also edits and combines clips. |\r\n\r\n---\r\n\r\n## Prerequisites\r\n\r\n| Requirement | Notes |\r\n|---|---|\r\n| Python | 3.10 or newer |\r\n| Node.js | 20 or newer |\r\n\r\nEverything else (Python packages, Node.js dependencies, Playwright / Chromium, LibreOffice, Poppler) is installed automatically on first run.\r\n\r\n---\r\n\r\n## Quick Start\r\n\r\n### Option A — Local install (interactive terminal)\r\n\r\n```bash\r\ngit clone https://github.com/VRSEN/openswarm.git\r\ncd openswarm\r\npython run.py\r\n```\r\n\r\nOn first run, a setup wizard walks you through choosing a provider and entering your API keys. Everything else (Python packages, Node.js dependencies, Playwright browser) installs automatically.\r\n\r\nOnce configured, `python run.py` drops you straight into the terminal UI. Outputs and generated files are written to `./mnt/`.\r\n\r\n---\r\n\r\n### Option B — Docker (API server; no system dependencies required)\r\n\r\nRequires [Docker](https://docs.docker.com/get-docker/).\r\n\r\n```bash\r\ngit clone https://github.com/VRSEN/openswarm.git\r\ncd openswarm\r\ncp .env.example .env        # fill in at least one provider key\r\ndocker-compose up --build\r\n```\r\n\r\nThe FastAPI server starts on `http://localhost:8080`.\r\n\r\n---\r\n\r\n## Running as an API\r\n\r\n```bash\r\npython server.py        # local install\r\n# or\r\ndocker-compose up       # Docker\r\n```\r\n\r\nStarts a FastAPI server on port **8080**. The agency is exposed at `/open-swarm`.\r\n\r\n---\r\n\r\n## Configuration\r\n\r\n### Provider & model\r\n\r\nSet your provider key and optionally override the default model in `.env`:\r\n\r\n```env\r\nOPENAI_API_KEY=sk-...\r\n\r\n# Optional: override the model used by all agents\r\nDEFAULT_MODEL=gpt-4o\r\n```\r\n\r\nThe onboarding wizard sets these automatically. You can also edit `.env` directly at any time — see `.env.example` for all options.\r\n\r\n### Optional integrations\r\n\r\n| Key(s) | Feature unlocked |\r\n|---|---|\r\n| `ANTHROPIC_API_KEY` | Claude models via LiteLLM |\r\n| `COMPOSIO_API_KEY` + `COMPOSIO_USER_ID` | 10,000+ external integrations via Virtual Assistant |\r\n| `SEARCH_API_KEY` | Web search, Scholar search, Product search ([searchapi.io](https://www.searchapi.io)) |\r\n| `GOOGLE_API_KEY` | Gemini image generation/editing, Veo video generation |\r\n| `FAL_KEY` | Seedance video generation, video editing, background removal |\r\n| `PEXELS_API_KEY` | Pexels stock photo search (Slides Agent) |\r\n| `PIXABAY_API_KEY` | Pixabay stock photo search (Slides Agent) |\r\n| `UNSPLASH_ACCESS_KEY` | Unsplash stock photo search (Slides Agent) |\r\n\r\nTools that require a missing key raise a clear error at call time — the agent will tell you what to add.\r\n\r\n---\r\n\r\n## Adding a New Agent\r\n\r\n1. Create a new folder: `my_agent/`\r\n2. Add `my_agent.py` (Agent definition), `instructions.md`, and `tools/`\r\n3. Register the agent in `swarm.py` → `create_agency()`\r\n\r\nSee the [Agency Swarm docs](https://vrsen.github.io/agency-swarm/) for the full agent creation guide.\r\n\r\n---\r\n\r\n## Learn More\r\n\r\n| Component | Library |\r\n|---|---|\r\n| Multi-agent framework | [Agency Swarm](https://github.com/VRSEN/agency-swarm) |\r\n| LLM runtime | [OpenAI Agents SDK](https://github.com/openai/openai-agents-python) |\r\n| External integrations | [Composio](https://composio.dev) |\r\n| Multi-provider LLM routing | [LiteLLM](https://docs.litellm.ai) |\r\n| API deployment | [FastAPI](https://fastapi.tiangolo.com) + Uvicorn |\r\n| SaaS platform | [Agent Swarm](https://agentswarm.ai) |\r\n\r\n---\r\n\r\n## License\r\n\r\nMIT — see [LICENSE](LICENSE).\r\n","readmeFilename":"README.md"}