Skip to main content

Troubleshooting personalization options for GitHub Codespaces

Troubleshooting steps for common issues with dotfiles and Settings Sync.

You can personalize GitHub Codespaces by using a dotfiles repository on GitHub Enterprise Cloud or by using Settings Sync. For more information, see "Personalizing GitHub Codespaces for your account."

Troubleshooting dotfiles

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.

Troubleshooting Settings Sync

You can disable Settings Sync to stop syncing settings to and from an instance of VS Code.

By default, when you disable Settings Sync, new codespaces continue to use the settings cached from the last time your settings were pushed to the cloud. If your codespaces are still being created with cached settings, and you want to return to using the default VS Code settings in your codespaces, you can clear the cache in the cloud when you disable Settings Sync.

  1. If Settings Sync is currently disabled in your instance of VS Code, you must first enable it. For instructions, see "Enabling Settings Sync."

  2. At the bottom of the Activity Bar, select and click Settings Sync is On.

  3. In the dropdown, click Settings Sync: Turn Off.

    Screenshot of the Settings Sync Turn Off option in VS Code

  4. To clear your cached settings, in the dialog, select Turn off sync on all your devices and clear the data from the cloud.

    Screenshot of the Turn Off Settings Sync dialog

  5. Click Turn off.