Cloud Workspaces (Collaboration)
Cloud Workspaces is the clearest current path for team-oriented MockForge usage. It combines shared workspace records, cloud sync, and collaborator management so teams can keep mocks aligned across local development and shared environments.
Overview
Cloud Workspaces provides:
- Cloud authentication via
mockforge cloud login - Shared workspace records with cloud workspace create/list/info flows
- Directory linking from a local project to a cloud workspace
- Cloud sync with status, history, and pending-change checks
- Team membership management through invite/list/remove commands
Quick Start
Authenticate
# Authenticate with MockForge Cloud
mockforge cloud login
# Check authentication status
mockforge cloud whoami
Create and Inspect a Cloud Workspace
# Create a shared cloud workspace
mockforge cloud workspace create my-workspace --name "My Workspace"
# List cloud workspaces
mockforge cloud workspace list
# Inspect a workspace
mockforge cloud workspace info my-workspace
Link a Local Project and Start Sync
# Link the current project directory to the cloud workspace
mockforge cloud workspace link . my-workspace
# Start bidirectional sync and watch for changes
mockforge cloud sync start --workspace my-workspace --watch
Hosted capture attribution
On the Hosted Mocks page, choose Workspace (optional) when creating a deployment, or open an existing deployment’s Overview, choose a workspace, and select Save workspace. Choose No workspace to detach it. Only workspaces in the deployment’s organization are accepted; changing attribution requires permission to update the deployment.
The selection applies to future recorder capture batches. Earlier captures keep their original workspace. Existing deployments stay unassigned until explicitly configured, and configuration JSON cannot override this selection. Deleting a workspace detaches its deployments using the existing workspace deletion rules; it does not move old captures into another workspace. Workspace-based verification and capture-source alerts can use newly attributed captures once their respective features are enabled.
The registry API accepts an optional top-level workspace_id on
POST /api/v1/hosted-mocks and returns the nullable field on deployment
create/list/get responses. To update an existing deployment, use
PATCH /api/v1/hosted-mocks/{deployment_id}/workspace with
{"workspace_id":"<workspace UUID>"}; use {"workspace_id":null} to detach.
An omitted update field is rejected. For multiple organizations, send the
deployment’s X-Organization-Id header.
Core Commands
Authentication and Identity
mockforge cloud loginmockforge cloud whoamimockforge cloud logout
Cloud Workspace Management
mockforge cloud workspace listmockforge cloud workspace create <workspace-id> --name "..."mockforge cloud workspace info <workspace-id>mockforge cloud workspace link <local-path> <cloud-workspace-id>mockforge cloud workspace unlink <local-path>
Team Membership
# Invite a collaborator
mockforge cloud team invite [email protected] \
--workspace my-workspace \
--role editor
# List collaborators
mockforge cloud team members --workspace my-workspace
# Remove a collaborator
mockforge cloud team remove [email protected] --workspace my-workspace
Sync Operations
# Show sync status
mockforge cloud sync status --workspace my-workspace
# Show pending changes
mockforge cloud sync pending --workspace my-workspace
# Show sync history
mockforge cloud sync history --workspace my-workspace
Notes on Readiness
- The cloud workspace and sync commands above are present in the CLI source and are the safest public workflow to document.
- Other collaboration surfaces exist in the codebase, but some older docs examples referenced command shapes that are not part of the current public CLI.
- If you are documenting a buyer-facing hosted workflow, prefer the verified
cloudandworkspaceflows above over speculative collaboration examples.
Local Admin Workspaces vs Cloud Workspaces
MockForge also has local admin-oriented workspace commands such as:
mockforge workspace listmockforge workspace create <workspace-id> --name "..."mockforge workspace info <workspace-id>
Those are useful for local or self-hosted admin flows, but they are distinct from the cloud collaboration commands documented above.
Related Topics
- Directory Synchronization - File-based sync outside cloud workflows
- MockOps Pipelines - Advanced automation surface
- Federation - Multi-workspace federation
- Analytics Dashboard - Usage analytics