1
0
mirror of synced 2025-12-22 11:26:57 -05:00
Files
docs/content/github/developing-online-with-codespaces/using-codespaces-in-visual-studio.md
Vanessa Yuen 3df90fc9b8 Hello git history spelunker!
Are you looking for something? Here is all of the GitHub Docs history in one single commit. Enjoy! 🎉
2020-09-27 14:10:11 +02:00

6.0 KiB

title, intro, product, versions
title intro product versions
Using Codespaces in Visual Studio You can develop in your codespace directly in {{ site.data.variables.product.prodname_vs }} by connecting with your account on {{ site.data.variables.product.product_name }}. {{ site.data.reusables.gated-features.codespaces }}
free-pro-team
*

{% note %}

Note: {{ site.data.variables.product.prodname_codespaces }} is currently in limited public beta and subject to change. During the beta period, {{ site.data.variables.product.prodname_dotcom }} does not make any guarantees about the availability of {{ site.data.variables.product.prodname_codespaces }}. Sign up for the limited public beta. For more information about joining the beta, see "About {{ site.data.variables.product.prodname_codespaces }}."

{% endnote %}

About Codespaces in {{ site.data.variables.product.prodname_vs }}

You can create a codespace in {{ site.data.variables.product.prodname_vs }} to develop applications in a Windows environment. When you use a codespace in {{ site.data.variables.product.prodname_vs }}, you can browse source code, build solutions, and commit changes to your repository.

You must create a codespace in {{ site.data.variables.product.prodname_vs }} to use it with the application. Codespaces created outside of {{ site.data.variables.product.prodname_vs }} can not currently be used with {{ site.data.variables.product.prodname_vs }}.

Prerequisites

Before you configure a codespace in {{ site.data.variables.product.prodname_vs }}, you must download the latest version of {{ site.data.variables.product.prodname_vs }} Preview.

Enabling the connection between {{ site.data.variables.product.prodname_vs }} and {{ site.data.variables.product.prodname_github_codespaces }}

Connecting to {{ site.data.variables.product.prodname_github_codespaces }} with the {{ site.data.variables.product.prodname_vs }} Preview is not enabled by default, so you will first need to enable the Preview Features option.

  1. In {{ site.data.variables.product.prodname_vs }} Preview, use the Tools drop-down menu, then click Options.
  2. Under Environment, select Preview Features and check the Connect to {{ site.data.variables.product.prodname_github_codespaces }} preview feature. Check the Connect to {{ site.data.variables.product.prodname_github_codespaces }} preview feature
  3. You will need to restart {{ site.data.variables.product.prodname_vs }} for the feature to be available.

Creating a codespace in {{ site.data.variables.product.prodname_vs }}

  1. When you launch {{ site.data.variables.product.prodname_vs }}, the Start Window will show a Connect to a codespace button under "Get started". Visual Studio Start window with Connect to a codespace
  2. Click Connect to a codespace.
  3. Click Sign in to {{ site.data.variables.product.prodname_dotcom }} and follow the prompts, or click Create one! to create a new {{ site.data.variables.product.prodname_dotcom }} account and sign into the account. Visual Studio sign in to {{ site.data.variables.product.prodname_dotcom }}
  4. Under "Codespace details", type the repository's URL you want {{ site.data.variables.product.prodname_github_codespaces }} to clone into your codespace.
  5. Optionally, use the Instance type and Suspend after drop-down menus to configure more codespace details. Visual Studio codespace details
  6. Click Create and Connect. {{ site.data.variables.product.prodname_github_codespaces }} will begin preparing the codespace and open {{ site.data.variables.product.prodname_vs }} after the codespace is ready. The codespace name will appear in the remote indicator in the menu. Visual Studio connected to eShopOnWeb repository codespace

Opening a codespace in {{ site.data.variables.product.prodname_vs }}

  1. Use the File drop-down menu, and click Connect to a Codespace. Visual Studio File Connect to a codespace menu item
  2. Under "{{ site.data.variables.product.prodname_github_codespaces }}", click the codespace you want to connect to, then click Connect. Visual Studio displaying available codespaces and details

Configuring a codespace for {{ site.data.variables.product.prodname_vs }}

The default codespace environment created by {{ site.data.variables.product.prodname_vs }} includes popular frameworks and tools such as .NET Core, Microsoft SQL Server, Python, and the Windows SDK. {{ site.data.variables.product.prodname_github_codespaces }} created with {{ site.data.variables.product.prodname_vs }} can be customized through a subset of devcontainers.json properties and a new tool called devinit, included with {{ site.data.variables.product.prodname_vs }}.

devinit

The devinit command-line tool lets you install additional frameworks and tools into your Windows development codespaces, as well as run PowerShell scripts or modify environment variables. devinit supports a configuration file called devinit.json, which can be added to your project for creating customized and repeatable development environments. For more information about Windows codespace configuration and devinit, see Customize a codespace in the {{ site.data.variables.product.prodname_vs }} documentation.