Remote Workspaces – Installation & Usage
Set up, connect to, and use Remote Workspaces inside Factory sessions
A remote workspace is a fully-configured, on-demand development environment that lives in the cloud. Remote workspaces give you the same tools and dependencies you’d expect locally—without any machine-setup friction—so you can build, test, and run code directly from Factory.
System Requirements
- A repository enabled in Factory
- A valid
devcontainer.json
(see below) - Manager role or higher to create remote workspaces
Open Workspace Settings
- In Factory, click the Settings icon from the left sidebar.
- Select Workspaces.
Create a New Remote Workspace
- Click New Workspace.
- Enter the repository you want to develop against.
- Give your workspace a friendly name (e.g., “frontend-workspace”).
- (Optional) Upload a custom
devcontainer.json
. - Click Create.
Factory clones your repo and prepares the environment—this can take a minute for large projects.
Verify Workspace Ready
The new workspace appears in the list with a status indicator. Once it shows Ready, you can use it from any session.
Understanding Devcontainers
A devcontainer defines everything your remote workspace needs—language runtimes, tools, and commands—so every workspace is identical and reproducible.
Minimal JavaScript Example
Save this file as .devcontainer/devcontainer.json
in your repo or upload it when creating the workspace.
Launching a Remote Workspace inside a Session
Open or Start a Session
Join any Factory session as usual.
Connect to Cloud Machine
- Click the CPU icon in the top-right toolbar.
- Choose Remote Machine.
- Select the workspace you created earlier.
- Factory attaches the remote workspace to your session.
Confirm Connection
A green indicator and machine name appear next to the CPU icon. You’re now interacting with the cloud workspace.
Everyday Usage
Run CLI Commands
Use the Terminal toolkit to execute commands like:
npm run dev pytest git statusOutput streams live into chat and logs.
Edit & Save Files
Open files from the repo, make changes, and save.
Files persist in the remote workspace and can be committed upstream when ready.
Port Forwarding
If your devcontainer exposes ports (e.g., 3000), Factory auto-detects and adds them to the Ports panel for browser preview.
Auto-Save Controls
Auto-save is disabled by default—enable it from the Session Settings panel whenever you want live file syncing.
Troubleshooting & Help
Need More Help?
Visit the full Remote Workspace Troubleshooting Guide