Skip to main content
Dev Container runtime runs each workspace in a container built from your project’s devcontainer.json. If your project already uses dev containers for VS Code or other editors, Xum can use the same configuration.

​
Requirements

  • Dev Container CLI: npm install -g @devcontainers/cli
  • Docker daemon running
  • A devcontainer.json in the project

​
How it works

  1. Xum creates a git worktree on the host machine
  2. Runs devcontainer up to build/start the container
  3. Commands execute inside the container via devcontainer exec
  4. Deleting the workspace stops the container and removes the worktree

​
Configuration

Select Dev Container in the workspace creation UI. If your project has multiple configs, choose one from the dropdown. Xum searches these locations:
  • .devcontainer.json
  • .devcontainer/devcontainer.json
  • .devcontainer/*/devcontainer.json (named configs)

​
Credential sharing

Like the Docker runtime, you can check “Share credentials” to enable git authentication inside the container:
  • SSH agent forwarding — Your SSH keys work without copying private keys
  • Git config — Host ~/.gitconfig is copied into the container
  • GitHub CLI — If GH_TOKEN is set in project secrets, it’s passed to the container

​
Filesystem layout

Worktrees live on the host at ~/.xum/src/<project>/<workspace>. The Dev Container CLI mounts the worktree at /workspaces/<name> by default, and Xum automatically translates workspace paths between the host and container. If other tools or scripts require absolute host paths, you can configure both sides to use the same path:

​
Notes

  • The Dev Container runtime button only appears if Xum finds a devcontainer.json in the project.