c70adf6702
* reorganizing security and access sections * updating delete doc * making vscode doc moore os agnostic * updating developing in a codespace * fixing broken links * fixing some broken links * fixing broken topic * fixing broken link * Managing users permissions for your organization and other stuff (#19231) * Add new 'Managing user permissions for your organization' article * Revise 'Managing access and security for Codespaces' and screenshot * Add codespaces to org repo permissions article * Apply suggestions from code review Co-authored-by: Amy Burns <timeyoutakeit@github.com> * fixing title to match slug * fixing broken link * updating personalization doc * updating troubleshooting guide * updating creating doc * adding information about when secrets are used * removing secrets stuff from this PR * Addig order of operations for codespaces * self review fixes * Apply suggestions from code review Co-authored-by: Allison Weins <3174849+2percentsilk@users.noreply.github.com> * renaming quickstart to correct pattern: * Apply suggestions from code review Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> * rewriting re. review comments * Codespaces landingpage (#19053) * adding new tables and linking to info on audit logs * editing some text: * adding new info on how to add image registry login * adding link and fixing table * formatting * formatting * Apply suggestions from code review Co-authored-by: Laura Coursen <lecoursen@github.com> * updaing private image registry secret info and other improvements * some minor fixes * fixing test errors * rewriting registry secret section * rewriting registry secret section * updating link to reflect title * Update content/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces.md Co-authored-by: Laura Coursen <lecoursen@github.com> * updating bullet point * moving codespaces to top-level item * fixing duplicated redirect * Adding some organization for contributors * adding learning codespaces to index file * do not error out if category array is empty * Apply suggestions from code review Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com> * fixing broken link * testing what is possible for the landing page * adding first run of landing page * adding new video and intro text * add landing page scaffolding * Update codespaces_code_examples.yml * lint * fixing issues in branch * fixing nav * fixing broken directs * Creating guides sub-landing page * adding topics * removing unused toopic * removing instant * updating landing page and guides page * updating versioning * removing unused topic * removing other versions: * actually fixing broken links * fixing title * fixing intro to suit the landing page * Apply suggestions from code review Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> * adding video * adding video * adding correct link for video * removing duplicated guides Co-authored-by: Laura Coursen <lecoursen@github.com> Co-authored-by: Sarah Schneider <sarahs@github.com> Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com> Co-authored-by: Rachael Sewell <rachmari@github.com> Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> * rewording and reorganizing code samples * fixing some feedback from engineering * Adding doc on Secrets in codespaces (#19248) * adding secrets docs * fixing some broken links * fixing some more broken redirects * copy edit and updating limits for secrets * adding limits for users * Apply suggestions from code review Co-authored-by: Felicity Chapman <felicitymay@github.com> * adding feedback Co-authored-by: Felicity Chapman <felicitymay@github.com> * updating beta banner * adding quickstarts to landing page * removing availability section from reusable Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> Co-authored-by: Allison Weins <3174849+2percentsilk@users.noreply.github.com> Co-authored-by: Laura Coursen <lecoursen@github.com> Co-authored-by: Sarah Schneider <sarahs@github.com> Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com> Co-authored-by: Rachael Sewell <rachmari@github.com> Co-authored-by: Felicity Chapman <felicitymay@github.com>
89 lines
6.0 KiB
Markdown
89 lines
6.0 KiB
Markdown
---
|
|
title: Using Codespaces in Visual Studio Code
|
|
intro: 'You can develop in your codespace directly in {% data variables.product.prodname_vscode %} by connecting the {% data variables.product.prodname_github_codespaces %} extension with your account on {% data variables.product.product_name %}.'
|
|
redirect_from:
|
|
- /github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code
|
|
- /github/developing-online-with-codespaces/connecting-to-your-codespace-from-visual-studio-code
|
|
- /github/developing-online-with-codespaces/using-codespaces-in-visual-studio
|
|
versions:
|
|
free-pro-team: '*'
|
|
type: how_to
|
|
topics:
|
|
- Codespaces
|
|
- Visual Studio Code
|
|
- Developer
|
|
---
|
|
|
|
{% data reusables.codespaces.release-stage %}
|
|
|
|
### Prerequisites
|
|
|
|
To develop in a codespace directly in {% data variables.product.prodname_vscode %}, you must sign into the {% data variables.product.prodname_github_codespaces %} extension. The {% data variables.product.prodname_github_codespaces %} extension requires {% data variables.product.prodname_vscode %} October 2020 Release 1.51 or later.
|
|
|
|
Use the {% data variables.product.prodname_vs %} Marketplace to install the [{% data variables.product.prodname_github_codespaces %}](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) extension. For more information, see [Extension Marketplace](https://code.visualstudio.com/docs/editor/extension-gallery) in the {% data variables.product.prodname_vscode %} documentation.
|
|
|
|
|
|
{% mac %}
|
|
|
|
{% data reusables.codespaces.click-remote-explorer-icon-vscode %}
|
|
2. Click **Sign in to view {% data variables.product.prodname_dotcom %}...**.
|
|
|
|
3. To authorize {% data variables.product.prodname_vscode %} to access your account on {% data variables.product.product_name %}, click **Allow**.
|
|
4. Sign in to {% data variables.product.product_name %} to approve the extension.
|
|
|
|
{% endmac %}
|
|
|
|
{% windows %}
|
|
|
|
{% data reusables.codespaces.click-remote-explorer-icon-vscode %}
|
|
2. Use the "REMOTE EXPLORER" drop-down, then click **{% data variables.product.prodname_github_codespaces %}**.
|
|
|
|
3. Click **Sign in to view {% data variables.product.prodname_codespaces %}...**.
|
|
|
|
4. To authorize {% data variables.product.prodname_vscode %} to access your account on {% data variables.product.product_name %}, click **Allow**.
|
|
5. Sign in to {% data variables.product.product_name %} to approve the extension.
|
|
|
|
{% endwindows %}
|
|
|
|
### Creating a codespace in {% data variables.product.prodname_vscode %}
|
|
|
|
After you connect your {% data variables.product.product_name %} account to the {% data variables.product.prodname_github_codespaces %} extension, you can develop in a codespace that you created on {% data variables.product.product_name %} or in {% data variables.product.prodname_vscode %}.
|
|
|
|
{% data reusables.codespaces.click-remote-explorer-icon-vscode %}
|
|
2. Click the Add icon, then click **Create New Codespace**.
|
|
|
|
3. Type, then click the repository's name you want to develop in.
|
|
|
|
4. Click the branch you want to develop on.
|
|
|
|
5. Click the machine type you want to develop in.
|
|
|
|
### Opening a codespace in {% data variables.product.prodname_vscode %}
|
|
|
|
{% data reusables.codespaces.click-remote-explorer-icon-vscode %}
|
|
2. Under "Codespaces", click the codespace you want to develop in.
|
|
3. Click the Connect to Codespace icon.
|
|
|
|
|
|
### Changing the machine type in {% data variables.product.prodname_vscode %}
|
|
|
|
{% data reusables.codespaces.codespaces-machine-types %}
|
|
|
|
You can change the machine type of your codespace at any time.
|
|
|
|
1. In {% data variables.product.prodname_vscode %}, open the Command Palette (`shift command P` / `shift control P`).
|
|
2. Search for and select "Codespaces: Change Machine Type."
|
|
|
|
3. Click the codespace that you want to change.
|
|
|
|
4. Choose the machine type you want to use.
|
|
|
|
|
|
If the codespace is currently running, a message is displayed asking if you would like to restart and reconnect to your codespace now. Click **Yes** if you want to change the machine type used for this codespace immediately. If you click **No**, or if the codespace is not currently running, the change will take effect the next time the codespace restarts.
|
|
|
|
### Deleting a codespace in {% data variables.product.prodname_vscode %}
|
|
|
|
1. Under "Codespaces", right-click the codespace you want to delete.
|
|
2. In the drop-down menu, click **Delete Codespace**.
|
|
|