* feat(operations): add create_project operation across agent, mcp, and cli * fix(api): remove legacy team creation endpoint * fix(api): preserve ProjectInfo response on POST /teams/:teamId/projects
Shumai
The best open-source Frame.io alternative for all your creative work.
Website | Docs | Demo | Discourse Forum | 中文
Features
Shumai is an open-source Frame.io alternative built for creative teams to collaborate and share media with ease:
- S3-Compatible & Local Storage: Store and serve creative assets securely using the local filesystem or any S3-compatible storage service, including AWS S3, Cloudflare R2, and MinIO.
- Archive Storage & Auto-Archival: Offload original master media files to secondary local storage or cold S3 storage—manually or automatically via team lifecycle policies—to save on storage costs while keeping proxies for instant browsing and playback. See Archive Storage documentation.
- Frame-by-Frame Annotations & Comments: Leave precise feedback with frame-specific drawing tools and timestamped comments on both video and image assets.
- Secure Sharing & Collections: Create private share links and curated media collections for clients, stakeholders, and collaborators.
- Granular Access Control: Manage workspace permissions with team-level and project-level role-based access control.
- Durable Workflows via DBOS: Run background tasks and AI agent workflows orchestrated reliably by DBOS on PostgreSQL with automatic recovery and fault tolerance.
- Scalable Deployment on Docker or Kubernetes: Horizontally autoscale video transcoding on multiple instances. See EKS Deployment Example.
- Custom Asset Metadata: Define dynamic metadata fields tailored to your production pipeline.
- Share Link Watermarking: Protect shared media with customizable text and image watermarks, and save watermark as reusable templates.
- Wide File Format Support: Preview common creative file formats, including images (with PSD support), videos, audio, and documents, while allowing any file type to be uploaded and stored.
- 3D Asset Turntable Previews: Generate interactive 3D model turntable previews and videos for formats like GLB, FBX, OBJ, STL, USD, and DAE using turntable-renderer.
- Office & Document PDF Proxying via Gotenberg: Convert Word, PowerPoint, Excel, Markdown, HTML, and CSV documents to high-quality PDF proxies for in-browser previewing using Gotenberg.
- Semantic Search: Find assets by visual or conceptual meaning using vector embeddings. See documentation.
- NLE Export & Premiere Pro Plugin (Experimental): Export timestamped review comments to your favorite non-linear editor (Premiere Pro XML, DaVinci Resolve EDL, Final Cut Pro, Avid Media Composer) or use the experimental Premiere Pro UXP plugin to import media assets and auto-sync comments directly to sequence timeline markers. See documentation.
- Built-in MCP Server & CLI: Connect external AI agents to Shumai via
/mcpor manage projects, assets, comments, and metadata from the terminal withshumai-cli.
But Shumai goes beyond being a Frame.io alternative. With modern models like GPT-Image-2 and Seedance 2.5, AI can already handle a surprising amount of creative work. That means you can create or update videos and images from a simple prompt without having to jump back into Photoshop, Premiere or Houdini. That is why Shumai includes a powerful agent system:
AI is optional. You can use Shumai as a traditional Frame.io alternative and completely ignore the AI features if they aren't useful for your team.
- Agent as a Team Member: Mention a context-aware AI agent with
@mentionsdirectly in asset comments, just like a real teammate. - Agent as a One-to-One Assistant: Chat privately with the agent and ask it to help with tasks.
- Custom Skills & Tools: Extend the agent by registering custom scripts, tools, and automation skills.
- Model Context Protocol (MCP): Connect agents to external tools and APIs through remote MCP servers, with OAuth authentication and per-agent MCP access.
- Isolated Sandbox Execution: Run agent-submitted scripts safely in a sandboxed environment.
- AI Metadata Autofill: Automatically fill in custom metadata for new assets.
- Resource Quotas: Set usage limits on AI tokens, costs, and tool execution per member, role, or team-wide, with real-time tracking.
Here is a short demo video showing what the Shumai agent can do:
https://github.com/user-attachments/assets/1186067a-72c0-41b9-836f-987438f2332a
Shumai also brings project management into the creative workflow. A built-in Kanban board helps teams organize tasks, track progress, and collaborate in one place.
The ultimate goal is an agentic Kanban, where agents and team members can work together on tasks. This is still a work in progress: you can already create tasks for AI agents, but agents cannot act on those tasks yet.
Note
Media Processing & Storage: When uploading media, Shumai always preserves and stores your original raw file. Note that the file size shown in the system represents the original file size and does not include the size of any transcoded files. For all media types (both images and videos), Shumai creates a 300p WebP poster image to serve as the preview in the file list view. Additionally:
- For Images: Shumai generates a high-quality WebP proxy at the exact same resolution as your original file for optimized viewing.
- For Videos: It generates at least one proxy video (depending on your transcoding settings), alongside a sprite image and a small preview video (capped at 1600 frames) to enable fast timeline scrubbing and lightning-quick previews.
Have feedback or ideas? Share them with us, and if you find Shumai useful, please give us a ⭐ or recommend Shumai to someone who might find it useful, it really helps!
Installation
Below is a quickstart guide for running Shumai with local storage. For advanced configuration options (including S3-compatible storage and distributed worker orchestration), see our Documentation.
Option 1: Docker Compose
Docker Compose is the fastest way to get Shumai running. You do not need to clone the repository or install packages manually. Ensure you have Docker and Docker Compose installed, then follow these steps:
-
Create and navigate to a new directory for your configuration and data volumes:
mkdir shumai && cd shumai -
Download your preferred
docker-compose.yamlconfiguration based on your needs and available RAM:-
Lite (Suggested RAM: 2 GB+): Minimal deployment containing Shumai and PostgreSQL database.
curl -o docker-compose.yaml https://raw.githubusercontent.com/shumaiOne/shumai/main/docker-compose/local/docker-compose.yaml -
With Embedding Server (Suggested RAM: 4 GB+): Adds local multimodal semantic search powered by
shumaiOne/embedding-server(EmbeddingGemma 2 740M).curl -o docker-compose.yaml https://raw.githubusercontent.com/shumaiOne/shumai/main/docker-compose/local/docker-compose.embedding.yaml -
Full (Suggested RAM: 8 GB+): All-in-one setup including
embedding-server,turntable-renderer(3D previews), andGotenberg(document PDF proxying).curl -o docker-compose.yaml https://raw.githubusercontent.com/shumaiOne/shumai/main/docker-compose/local/docker-compose.full.yaml
Note
By default, the Docker Compose setups use CPU software transcoding. If your server has a GPU (NVIDIA NVENC, Intel QuickSync, AMD/Intel VA-API, or Rockchip RKMPP) and you want to enable GPU hardware acceleration, check the Hardware Transcoding Guide.
-
-
Configure environment variables:
-
BETTER_AUTH_URL: The public base URL of your Shumai server (e.g.,https://shumai.example.comorhttp://12.34.56.78:3000). It is used for:- Password reset links: Generates CLI and user password reset URLs (
{BETTER_AUTH_URL}/reset-password?token=...). - Email notification deep links: Default base URL for notification emails (if
APP_URLis unset). - Session cookie security: Determines whether to issue session cookies with
Secureflags and__Secure-prefixes for HTTPS deployments. - MCP OAuth 2.1 & discovery: Sets the OAuth resource identifier (
{BETTER_AUTH_URL}/mcp), discovery endpoints (/.well-known/...), and default redirect URI for outbound MCP OAuth.
Note
Email/password Web UI login works over plain HTTP/IP even if
BETTER_AUTH_URLis omitted. However, setting it is strongly recommended for production, custom domains, or HTTPS deployments. Note that remote deployments must use HTTPS for MCP OAuth 2.1 (RFC 9728); if an HTTP IP address or domain is used, MCP OAuth 2.1 is gracefully disabled while the Web UI and MCP API tokens remain functional. - Password reset links: Generates CLI and user password reset URLs (
-
BETTER_AUTH_SECRET: A random secret key used to sign session cookies, JWTs, and presigned file upload/download URLs (in local storage mode). A default placeholder is included in the template for instant local trials, but you must generate a unique secret for production or public deployments (e.g., runopenssl rand -base64 32). -
AWS_ENDPOINT_URL_S3: By default,AWS_ENDPOINT_URL_S3is set tohttp://localhost:{SHUMAI_SERVER_PORT}. When you use local storage (the default storage backend withSTORAGE_BACKEND: local) and expose Shumai on a remote server, custom domain, or custom host/port combination, setAWS_ENDPOINT_URL_S3to the external URL that client browsers will use to upload and download files.For example, if you change the port mapping in
docker-compose.yamlfrom3000:3000to12345:3000and deploy on a server with IP address12.34.56.78, set:AWS_ENDPOINT_URL_S3: http://12.34.56.78:12345This value must be reachable from client browsers and should include the externally exposed port.
-
SHUMAI_SERVER_PORT: Controls the port the Shumai server listens on. The default is3000. -
External S3 Storage: By default, Shumai uses the bundled local storage service in this Docker Compose setup. To use an external S3-compatible storage instead, configure the environment variables for your S3 provider. Here are examples for AWS S3 and Cloudflare R2:
AWS S3 Example:
STORAGE_BACKEND: s3 S3_BUCKET: your-bucket-name S3_ACCESS_KEY_ID: your-access-key-id S3_SECRET_ACCESS_KEY: your-secret-access-key AWS_ENDPOINT_URL_S3: https://s3.us-east-1.amazonaws.comCloudflare R2 Example:
STORAGE_BACKEND: s3 S3_BUCKET: your-bucket-name S3_REGION: auto S3_ACCESS_KEY_ID: your-access-key-id S3_SECRET_ACCESS_KEY: your-secret-access-key AWS_ENDPOINT_URL_S3: https://<account-id>.r2.cloudflarestorage.com
-
-
Start the services in detached mode:
docker compose up -d -
Open your browser and access Shumai at
http://localhost:3000(orhttp://<your-server-ip>:3000for remote deployments).
Scaling Transcode Workers (Parallel Processing)
By default, the Docker Compose deployment transcodes videos one-by-one. This is by design, as video transcoding is compute-intensive and can saturate available CPU or GPU resources.
However, when uploading large batches (e.g., 100+ videos at once) or massive raw camera files that take hours to process and block subsequent uploads, you can scale transcoding throughput across additional machines. Each machine still processes tasks sequentially, but adding more worker instances increases overall parallel capacity.
Shumai makes this seamless with a dedicated shumaione/shumai-transcode Docker image:
-
Connect: Launch a temporary machine and ensure network access to your PostgreSQL database and storage backend (e.g., S3 or shared storage).
-
Start the worker: Run the container with matching database and storage credentials:
docker run -d --name shumai_transcode_worker \ -e DATABASE_URL="postgres://shumai:shumai_password@<postgres-host>:5432/shumai_db?sslmode=disable" \ -e STORAGE_BACKEND="s3" \ -e S3_BUCKET="your-bucket-name" \ -e AWS_ENDPOINT_URL_S3="https://s3.us-east-1.amazonaws.com" \ -e S3_ACCESS_KEY_ID="your-access-key-id" \ -e S3_SECRET_ACCESS_KEY="your-secret-access-key" \ shumaione/shumai-transcode:latestThe worker will automatically attach to the task queue and begin processing pending transcode jobs in parallel with your primary instance.
-
Stop anytime: Once the transcoding backlog finishes (or whenever you no longer need the extra compute), simply stop or remove the worker:
docker stop shumai_transcode_workerThere is no downtime or impact on the main Shumai application.
Option 2: Run from Source (Development)
To set up Shumai locally for development:
- Clone the repository and install dependencies:
git clone https://github.com/shumaiOne/shumai.git cd shumai bun install - Start the
pgvectordatabase container:docker run --name shumai_postgres \ -e POSTGRES_USER=shumai \ -e POSTGRES_PASSWORD=shumai_password \ -e POSTGRES_DB=shumai_db \ -p 5432:5432 \ -d pgvector/pgvector:pg18 - Create a
.envfile at the root of the workspace:DATABASE_URL=postgresql://shumai:shumai_password@localhost:5432/shumai_db?schema=public BETTER_AUTH_SECRET=ySxs7DxzHDZBbeeHNPEwBuspYwipBqz5Gk5XdBjNhWw= BETTER_AUTH_URL=http://localhost:3000 STORAGE_BACKEND=local SHUMAI_SERVER_PORT=3000 AWS_ENDPOINT_URL_S3=http://localhost:3000 - Generate i18n translation files:
bun run i18n:compileTip
During frontend development, you can run
bun run i18n:watchin a separate terminal to automatically recompile translation files whenever you edit strings inpackages/webui/messages/. - Apply the database schema migrations:
bun run db:migrate - Start the local development server:
bun run dev
Note
Looking to install Shumai globally via NPM or your package manager? See our NPM Installation Guide.
Command Line Interface (CLI)
Shumai provides a Command Line Interface (CLI) tool to manage projects, folders, and assets, upload files/folders, and create new versions directly from your terminal.
Install the standalone CLI on macOS/Linux without Node.js or Bun:
curl -fsSL https://github.com/shumaiOne/shumai/releases/latest/download/install.sh | sh
On Windows:
powershell -NoProfile -ExecutionPolicy Bypass -Command "irm https://github.com/shumaiOne/shumai/releases/latest/download/install.ps1 | iex"
The npm installation remains available: npm install -g @shumai-one/shumai-cli (Node.js 22.12+).
For more details on installation and usage, see the CLI Readme.
MCP Server
Shumai includes a built-in MCP server at /mcp, so external agents such as Claude Code, Cursor, or Kiro can browse and organize your projects with OAuth or an API token. See the MCP server guide for setup.
Community
Thanks to LINUX DO for providing a community for open-source discussions and feedback.

