Skip to main content

Troubleshooting dotfiles for GitHub Codespaces

Troubleshooting steps for common dotfiles issues.

GitHub Codespaces is available for organizations using GitHub Team or GitHub Enterprise Cloud. GitHub Codespaces is also available as a limited beta release for individual users on GitHub Free and GitHub Pro plans. For more information, see "GitHub's products."

If your codespace fails to pick up configuration settings from dotfiles, you should work through the following debugging steps.

  1. Enable dotfiles by selecting Automatically install dotfiles in your personal GitHub Codespaces settings.

    The 'Automatically install dotfiles' option

  2. Check /workspaces/.codespaces/.persistedshare/dotfiles to see if your dotfiles were cloned.

    • If your dotfiles were cloned, try manually re-running your install script to verify that it is executable.
    • If your dotfiles were not cloned, check /workspaces/.codespaces/.persistedshare/EnvironmentLog.txt to see if there was a problem cloning them.
  3. Check /workspaces/.codespaces/.persistedshare/creation.log for possible issues. For more information, see Creation logs.

If the configuration from your dotfiles is correctly picked up, but part of the configuration is incompatible with codespaces, use the $CODESPACES environment variable to add conditional logic for codespace-specific configuration settings.