devcontainer-feature.json

{
  "id": "dotfiles-sync",
  "version": "1.2.3",
  "name": "Dotfiles Sync",
  "description": "Syncs local Git, SSH, GPG, npm, yarn config files into the devcontainer. Optionally syncs cloud credentials (AWS, kube, Docker) and SSH private key files — opt-in only. Works on macOS, Linux, Windows (WSL), Codespaces, Gitpod, DevPod. Merges instead of overwriting. Also self-heals your devcontainer setup.",
  "documentationURL": "https://github.com/helpers4/devcontainer/tree/main/src/dotfiles-sync",
  "licenseURL": "https://github.com/helpers4/devcontainer/blob/main/LICENSE",
  "keywords": ["helpers4", "dotfiles", "git", "ssh", "sync"],
  "options": {
    "username": {
      "type": "string",
      "default": "node",
      "description": "Username in the container that should receive synchronized local config files"
    },
    "syncAwsConfig": {
      "type": "boolean",
      "default": false,
      "description": "Sync ~/.aws/config (profiles only, NOT ~/.aws/credentials which contains long-lived access keys)."
    },
    "syncKubeConfig": {
      "type": "boolean",
      "default": false,
      "description": "Sync ~/.kube/config (cluster credentials and tokens). Skipped on cloud environments."
    },
    "syncDockerConfig": {
      "type": "boolean",
      "default": false,
      "description": "Sync ~/.docker/config.json (registry auth tokens). Skipped on cloud environments."
    },
    "syncSshKeys": {
      "type": "boolean",
      "default": false,
      "description": "Sync SSH private/public key files themselves (~/.ssh/id_*). Off by default: SSH auth normally works through the client's own forwarded ssh-agent with no local key file needed, and enabling this puts private key material on the container's filesystem. ~/.ssh/config and known_hosts always sync regardless — agent forwarding doesn't provide either of those."
    }
  },
  "mounts": [
    {
      "source": "${localEnv:HOME}/.gitconfig",
      "target": "/mnt/h4dotfiles/.gitconfig",
      "type": "bind"
    },
    {
      "source": "${localEnv:HOME}/.config/git",
      "target": "/mnt/h4dotfiles/.config/git",
      "type": "bind"
    },
    {
      "source": "${localEnv:HOME}/.ssh",
      "target": "/mnt/h4dotfiles/.ssh",
      "type": "bind"
    },
    {
      "source": "${localEnv:HOME}/.gnupg",
      "target": "/mnt/h4dotfiles/.gnupg",
      "type": "bind"
    },
    {
      "source": "${localEnv:HOME}/.npmrc",
      "target": "/mnt/h4dotfiles/.npmrc",
      "type": "bind"
    },
    {
      "source": "${localEnv:HOME}/.yarnrc.yml",
      "target": "/mnt/h4dotfiles/.yarnrc.yml",
      "type": "bind"
    },
    {
      "source": "${localEnv:HOME}/.aws/config",
      "target": "/mnt/h4dotfiles/.aws/config",
      "type": "bind"
    },
    {
      "source": "${localEnv:HOME}/.kube/config",
      "target": "/mnt/h4dotfiles/.kube/config",
      "type": "bind"
    },
    {
      "source": "${localEnv:HOME}/.docker/config.json",
      "target": "/mnt/h4dotfiles/.docker/config.json",
      "type": "bind"
    }
  ],
  "containerEnv": {
    "GPG_TTY": "/dev/pts/0"
  },
  "postStartCommand": "/usr/local/share/dotfiles-sync/sync-files.sh",
  "installsAfter": [
    "ghcr.io/devcontainers/features/common-utils"
  ],
  "dependsOn": {
    "ghcr.io/helpers4/devcontainer/helpers4-common:1": {}
  }
}