How shumaione/shumai works
Shumai is a creative-team media review and collaboration platform, with a web UI, API and core domain services, plus an experimental Premiere Pro plugin and optional AI capabilities. The main workflow is browsing or uploading project media, reviewing it with comments and annotations, and sharing or organizing it with a team. README-described capabilities include transcoding and previews, metadata, search, Kanban, and integrations. Some subsystems are represented from the README and tree; their internal wiring is not inferred where source was not sampled.
Main entry points: src/index.ts HTTP API · src/index.ts Application database · agent-chat.ts Agent workflows · asset.ts Assets and folders
Components 28
User experiences
- Web application
packages/webui/index.tsx - File browser and review
packages/webui/components/file-system-manager.tsx - Public share viewer
packages/webui/components/public-share-manager.tsx - Premiere Pro plugin
apps/premiere-uxp/src/App.tsx - CLI
apps/cli/src/index.ts
Collaboration domain
- HTTP API
packages/api/src/index.ts - Projects and teams
packages/core/src/project/project.ts - Assets and folders
packages/core/src/asset/asset.ts - Comments and annotations
packages/core/src/chat/chat.ts - Shares and collections
packages/core/src/share/share.ts - Access control
packages/core/src/authz/authz.ts - Custom metadata
packages/core/src/metadata/metadata.ts - Kanban tasks
packages/core/src/kanban/kanban.ts - Semantic search
packages/core/src/search/search.ts - Application database
packages/db/src/index.ts
Media handling
- Asset storage
packages/core/src/s3/s3.ts - Media transcode workflows
packages/transcode/src/workflows/transcode.ts - Preview conversion
packages/core/src/s3/preview-converter.ts
AI capabilities
- Agent workflows
packages/agent/src/workflows/agent-chat.ts - Agent tools
packages/agent/src/tools/list-assets.ts - MCP connections
packages/core/src/mcp/mcp-server-manager.ts - Sandbox execution
packages/core/src/sandbox/sandbox-service.ts
External integrations
- Premiere Pro
- S3-compatible storage
- Temporal workers
- Gotenberg
- Remote MCP servers
Other components
- Creative team member
Connections 31
- Creative team member → Web application: uses
- Web application → File browser and review: opens media
- File browser and review → HTTP API: requests files
- Public share viewer → HTTP API: fetches shared media
- Premiere Pro plugin → Premiere Pro: reads sequences
- Premiere Pro plugin → HTTP API: fetches comments
- CLI → HTTP API: manages assets
- HTTP API → Projects and teams: serves project operations
- HTTP API → Assets and folders: serves asset operations
- HTTP API → Shares and collections: serves share operations
- HTTP API → Comments and annotations: serves review operations
- HTTP API → Kanban tasks: serves task operations
- HTTP API → Custom metadata: serves metadata operations
- HTTP API → Semantic search: serves search requests
- Assets and folders → Asset storage: stores media
- Asset storage → S3-compatible storage: reads and writes
- Media transcode workflows → Temporal workers: runs workflows
- Media transcode workflows → Asset storage: processes media
- Preview conversion → Gotenberg: converts documents
- Agent workflows → Agent tools: dispatches tools
- Agent workflows → MCP connections: uses configured tools
- MCP connections → Remote MCP servers: connects to
- Agent workflows → Sandbox execution: runs scripts
- Agent workflows → Semantic search: supports asset discovery
- Assets and folders → Application database: persists asset records
- Projects and teams → Application database: persists project data
- Comments and annotations → Application database: persists review data
- Access control → Application database: reads access data
- Custom metadata → Application database: persists field values
- Kanban tasks → Application database: persists tasks
- Shares and collections → Application database: persists shares