devcontainer-feature.json

{
  "name": "GitHub Codespace dotfiles",
  "id": "codespaces-dotfiles",
  "version": "1.0.0",
  "description": "Install your dotfiles repository into GitHub Codespaces from your `devcontainer.json`. This feature will not do anything outside of GitHub Codespaces and will leave the dotfile setup to the [VS Code builtin personalization option](https://code.visualstudio.com/docs/devcontainers/containers#_personalizing-with-dotfile-repositories).",
  "documentationURL": "https://github.com/jpawlowski/devcontainer-features/tree/main/src/codespaces-dotfiles",
  "licenseURL": "https://github.com/jpawlowski/devcontainer-features/tree/main/LICENSE.txt",
  "keywords": [
    "codespaces",
    "devcontainers",
    "dotfiles"
  ],
  "options": {
    "repository": {
      "type": "string",
      "default": "",
      "description": "URL of a dotfiles Git repository (e.g., https://github.com/owner/repository.git) or owner/repository of a GitHub repository."
    },
    "targetPath": {
      "type": "string",
      "default": "",
      "description": "The path to clone the dotfiles repository to. Defaults to `~/dotfiles`."
    },
    "installCommand": {
      "type": "string",
      "default": "",
      "description": "The command to run after cloning the dotfiles repository. Defaults to run the first file of `install.sh`, `install`, `bootstrap.sh`, `bootstrap`, `setup.sh` and `setup` found in the dotfiles repository's root folder. If none of these files are found, then the `installFallbackMethod` will be used."
    },
    "installFallbackMethod": {
      "type": "string",
      "enum": [
        "symlink",
        "copy"
      ],
      "default": "symlink",
      "description": "The method to use if no install command is found. Defaults to `symlink`. This will symlink or copy any files or folders in your dotfiles repository starting with . to the codespace's ~ or $HOME directory."
    }
  },
  "postStartCommand": "/usr/local/share/devcontainers/features/codespaces-dotfiles/postStartOnce.sh",
  "installsAfter": [
    "ghcr.io/devcontainers/features/common-utils",
    "ghcr.io/devcontainers/features/git",
    "ghcr.io/devcontainers/features/github-cli",
    "ghcr.io/devcontainers/features/powershell",
    "ghcr.io/jpawlowski/devcontainer-features/powershell-extended"
  ]
}