ScriptBee

What is ScriptBee?

ScriptBee is a tool that helps the analysis of different models. Different tools create data and with the help of loaders, ScriptBee can load the data and create a model. The model can then be analyzed by running different scripts written in C#, Javascript and Python on it.

Quick Start

The fastest way to get started with ScriptBee is using Docker Compose.

Run with Docker

The fastest way to get started is by using Docker Compose. Create a docker-compose.yaml file with the following configuration and run docker compose up -d:

services:
  mongo:
    image: mongo:8.0.4
    container_name: mongo
    restart: unless-stopped
    environment:
      MONGO_INITDB_ROOT_USERNAME: root
      MONGO_INITDB_ROOT_PASSWORD: example
    ports:
      - "27017:27017"
    volumes:
      - mongodb_data:/data/db

  scriptbee:
    image: dxworks/scriptbee:latest
    user: root
    ports:
      - "4201:80"
    volumes:
      - ./database/scriptbee:/root/.scriptbee
      - /var/run/docker.sock:/var/run/docker.sock
    environment:
      - ConnectionStrings__mongodb=mongodb://root:example@mongo:27017/ScriptBee?authSource=admin
      - UserFolder__UserFolderPath=/root/.scriptbee
      - SCRIPTBEE__ANALYSIS__DRIVER=docker
      - SCRIPTBEE__ANALYSIS__DOCKER__DOCKERSOCKET=unix:///var/run/docker.sock
      - SCRIPTBEE__ANALYSIS__DOCKER__USERFOLDERHOSTPATH=${PWD}/database/scriptbee
      - SCRIPTBEE__PLUGINS__INSTALLATIONFOLDER=/app/plugins
    depends_on:
      - mongo

volumes:
  scriptbee-plugins:
  mongodb_data:

Docker Hosting Tips

Setting	Importance
user: root	Allows the ScriptBee container to communicate with the host's Docker engine.
${PWD}	Ensures absolute path resolution on the host machine for analysis volume mounts.
unix:///var/run/docker.sock	The standard socket for Docker-out-of-Docker communication.

Accessing the UI

Once the containers are running, open your browser and navigate to http://localhost:4201.

---

Configuration

ScriptBee can be configured using environment variables. Below are the most important settings:

Variable	Description	Default
ConnectionStrings__mongodb	Connection string for the MongoDB instance used for persistence.	mongodb://mongo:27017...
UserFolder__UserFolderPath	Host path for storing project data and shared files.
SCRIPTBEE_ANALYSIS__DRIVER	How analysis instances are managed: docker or kubernetes.	docker

For more detailed information on advanced configuration, check the Deployment Features documentation.

---

VS Code Extension

The official ScriptBee VS Code Extension lets you manage your scripts and connections directly from your editor. Key capabilities include:

• 🔌 Multi-connection management — connect to local, staging, or production ScriptBee instances.
• 📂 Script synchronization — push, pull, or sync all scripts; or push/pull a single file via right-click.
• 🔍 Compare with Remote — built-in diff view to review server changes before syncing.

Install

Search for ScriptBee in the VS Code Extensions Marketplace, or install from VSIX by downloading from the GitHub Releases page.

For full extension documentation, including configuration options and a complete command reference, see the VS Code Extension Guide.

---

Documentation

Full documentation is available at https://dxworks.org/scriptbee/.

Contributing

For information on the repository structure, development setup, and how to contribute, please refer to our Contributing Guide.