docs/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md

title, intro, versions, redirect_from, type, topics, shortTitle

title	intro	versions	redirect_from	type	topics	shortTitle
Forwarding ports in your codespace	{% data reusables.codespaces.about-port-forwarding %}	fpt ghec * *	/github/developing-online-with-codespaces/forwarding-ports-in-your-codespace	how_to	Codespaces Fundamentals Developer	Forward ports

{% jetbrains %}

{% data reusables.codespaces.codespaces-jetbrains-beta-note %}

{% endjetbrains %}

About forwarded ports

Port forwarding gives you access to TCP ports running within your codespace. For example, if you're running a web application on a particular port in your codespace, you can forward that port. This allows you to access the application from the browser on your local machine for testing and debugging.

{% webui %}

{% data reusables.codespaces.port-forwarding-intro-non-jetbrains %} {% data reusables.codespaces.navigate-to-ports-tab %}

1. Under the list of ports, click Add port.

   

2. Type the port number or address, then press enter.

   

Using HTTPS forwarding

By default, {% data variables.product.prodname_github_codespaces %} forwards ports using HTTP but you can update any port to use HTTPS, as needed. If you update a port with public visibility to use HTTPS, the port's visibility will automatically change to private.

{% data reusables.codespaces.navigate-to-ports-tab %}

1. Right click the port you want to update, then hover over Change Port Protocol.
2. Select the protocol needed for this port. The protocol that you select will be remembered for this port for the lifetime of the codespace.

{% data reusables.codespaces.port-forwarding-sharing-non-jetbrains %}

{% data reusables.codespaces.navigate-to-ports-tab %}

1. Right click the port that you want to share, select the "Port Visibility" menu, then click Private to Organization or Public.
2. To the right of the local address for the port, click the copy icon.
3. Send the copied URL to the person you want to share the port with.

{% data reusables.codespaces.port-forwarding-labeling-non-jetbrains %} {% data reusables.codespaces.port-forwarding-adding-non-jetbrains %}

{% endwebui %}

{% vscode %}

{% data reusables.codespaces.port-forwarding-intro-non-jetbrains %} {% data reusables.codespaces.navigate-to-ports-tab %}

1. Under the list of ports, click Add port.

   

2. Type the port number or address, then press enter.

   

{% data reusables.codespaces.port-forwarding-sharing-non-jetbrains %}

{% data reusables.codespaces.navigate-to-ports-tab %}

1. Right click the port that you want to share, select the "Port Visibility" menu, then click Private to Organization or Public.
2. To the right of the local address for the port, click the copy icon.
3. Send the copied URL to the person you want to share the port with.

{% data reusables.codespaces.port-forwarding-labeling-non-jetbrains %} {% data reusables.codespaces.port-forwarding-adding-non-jetbrains %}

{% endvscode %}

{% cli %}

{% data reusables.cli.cli-learn-more %}

To forward a port use the gh codespace ports forward subcommand. Replace codespace-port:local-port with the remote and local ports that you want to connect. After entering the command choose from the list of codespaces that's displayed.

gh codespace ports forward CODESPACE-PORT:LOCAL-PORT

For more information about this command, see the {% data variables.product.prodname_cli %} manual.

To see details of forwarded ports enter gh codespace ports and then choose a codespace.

{% data reusables.codespaces.port-forwarding-sharing-non-jetbrains %}

To change the visibility of a forwarded port, use the gh codespace ports visibility subcommand. {% data reusables.codespaces.port-visibility-settings %}

Replace codespace-port with the forwarded port number. Replace setting with private, org, or public. After entering the command choose from the list of codespaces that's displayed.

gh codespace ports visibility CODESPACE-PORT:SETTINGS

You can set the visibility for multiple ports with one command. For example:

gh codespace ports visibility 80:private 3000:public 3306:org

For more information about this command, see the {% data variables.product.prodname_cli %} manual.

{% data reusables.codespaces.port-forwarding-labeling-non-jetbrains %}

You can see the port labels when you list the forwarded ports for a codespace. To do this, use the gh codespace ports command and then select a codespace.

{% data reusables.codespaces.port-forwarding-adding-non-jetbrains %}

{% endcli %}

{% jetbrains %}

Forwarding a port

For information on how to forward a port in a codespace to a port on your local machine, see the "Port forwarding" section of the "Security model" article in the JetBrains documentation.

Alternatively, you can use {% data variables.product.prodname_cli %} to forward a port. For more information, click the "{% data variables.product.prodname_cli %}" tab at the top of this page.

{% endjetbrains %}