Skip to content

Latest commit

 

History

History
269 lines (174 loc) · 10.7 KB

using-github-codespaces-with-github-cli.md

File metadata and controls

269 lines (174 loc) · 10.7 KB
Raw
title shortTitle intro versions type topics redirect_from
Using GitHub Codespaces with GitHub CLI
GitHub CLI
You can work with {% data variables.product.prodname_github_codespaces %} directly from your command line by using `gh`, the {% data variables.product.product_name %} command line interface.
fpt ghec
*
*
how_to
Codespaces
CLI
Developer
/codespaces/developing-in-codespaces/using-codespaces-with-github-cli
/codespaces/developing-in-codespaces/using-github-codespaces-with-github-cli

About {% data variables.product.prodname_cli %}

{% data reusables.cli.about-cli %} For more information, see "AUTOTITLE."

You can work with {% data variables.product.prodname_github_codespaces %} in the {% data variables.product.prodname_cli %} to:

Installing {% data variables.product.prodname_cli %}

{% data reusables.cli.cli-installation %}

Using {% data variables.product.prodname_cli %}

If you have not already done so, run gh auth login to authenticate with your {% data variables.product.prodname_dotcom %} account.

To use gh to work with {% data variables.product.prodname_github_codespaces %}, type gh codespace SUBCOMMAND or its alias gh cs SUBCOMMAND.

As an example of a series of commands you might use to work with {% data variables.product.prodname_github_codespaces %}, you could:

  • List your current codespaces, to check whether you have a codespace for a particular repository:
    gh codespace list
  • Create a new codespace for the required repository branch:
    gh codespace create -r github/docs -b main
  • SSH into the new codespace:
    gh codespace ssh -c octocat-literate-space-parakeet-7gwrqp9q9jcx4vq
  • Forward a port to your local machine:
    gh codespace ports forward 8000:8000 -c octocat-literate-space-parakeet-7gwrqp9q9jcx4vq

gh commands for {% data variables.product.prodname_github_codespaces %}

The sections below give example commands for each of the available operations.

For a complete reference of gh commands for {% data variables.product.prodname_github_codespaces %}, including details of all available options for each command, see the {% data variables.product.prodname_cli %} online help for "gh codespace." Alternatively, on the command line, use gh codespace --help for general help or gh codespace SUBCOMMAND --help for help with a specific subcommand.

{% note %}

Note: The -c CODESPACE_NAME flag, used with many commands, is optional. If you omit it a list of codespaces is displayed for you to choose from.

{% endnote %}

List all of your codespaces

gh codespace list

The list includes the unique name of each codespace, which you can use in other gh codespace commands.

An asterisk at the end of the branch name for a codespace indicates that there are uncommitted or unpushed changes in that codespace.

Create a new codespace

gh codespace create -r OWNER/REPO_NAME [-b BRANCH]

For more information, see "AUTOTITLE."

View details of a codespace

gh codespace view

After running this command you are prompted to choose one of your existing codespaces. The following information is then displayed:

  • Name of the codespace
  • State (for example, "Available" or "Shutdown")
  • Repository
  • Git status
  • Path to the dev container configuration file used to create the codespace
  • Machine type
  • Idle timeout
  • Date and time the codespace was created
  • Retention period

For more information, see the {% data variables.product.prodname_dotcom %} CLI reference.

Stop a codespace

gh codespace stop -c CODESPACE-NAME

For more information, see "AUTOTITLE."

Delete a codespace

gh codespace delete -c CODESPACE-NAME

For more information, see "AUTOTITLE."

Rename a codespace

gh codespace edit -c CODESPACE-NAME -d 'DISPLAY-NAME'

For more information, see "AUTOTITLE."

Rebuild a codespace

gh codespace rebuild

To perform a full rebuild, add --full at the end of this command. For more information, see "AUTOTITLE."

When you use this command to rebuild a codespace, it uses the devcontainer.json file that is currently saved in the codespace's system. This happens regardless of whether or not the current state of the file has been saved in source control. For more information, see "AUTOTITLE."

SSH into a codespace

To run commands on the remote codespace machine, from your terminal, you can SSH into the codespace.

gh codespace ssh -c CODESPACE-NAME

{% note %}

Note: {% data reusables.codespaces.ssh-server-installed %}


For more information about the devcontainer.json file and the default container image, see "AUTOTITLE."

{% endnote %}

{% data variables.product.prodname_github_codespaces %} creates a local SSH key automatically to provide a seamless authentication experience. For more information on connecting with SSH, see gh codespace ssh.

Open a codespace in {% data variables.product.prodname_vscode %}

gh codespace code -c CODESPACE-NAME

You must have {% data variables.product.prodname_vscode_shortname %} installed on your local machine. For more information, see "AUTOTITLE."

Open a codespace in JupyterLab

gh codespace jupyter -c CODESPACE-NAME

{% data reusables.codespaces.jupyterlab-installed-in-codespace %}

Copy a file to/from a codespace

gh codespace cp [-r] SOURCE(S) DESTINATION

Use the prefix remote: on a file or directory name to indicate that it's on the codespace. As with the UNIX cp command, the first argument specifies the source and the last specifies the destination. If the destination is a directory, you can specify multiple sources. Use the -r (recursive) flag if any of the sources is a directory.

The location of files and directories on the codespace is relative to the home directory of the remote user.

Examples

  • Copy a file from the local machine to the $HOME directory of a codespace:

    gh codespace cp myfile.txt remote:

  • Copy a file to the directory in which a repository is checked out in a codespace:

    gh codespace cp myfile.txt remote:/workspaces/REPOSITORY-NAME

  • Copy a file from a codespace to the current directory on the local machine:

    gh codespace cp remote:myfile.txt .

  • Copy three local files to the $HOME/temp directory of a codespace:

    gh codespace cp a1.txt a2.txt a3.txt remote:temp

  • Copy three files from a codespace to the current working directory on the local machine:

    gh codespace cp remote:a1.txt remote:a2.txt remote:a3.txt .

  • Copy a local directory into the $HOME directory of a codespace:

    gh codespace cp -r mydir remote:

  • Copy a directory from a codespace to the local machine, changing the directory name:

    gh codespace cp -r remote:mydir mydir-localcopy

For more information about the gh codespace cp command, including additional flags you can use, see the {% data variables.product.prodname_cli %} manual.

Modify ports in a codespace

You can forward a port on a codespace to a local port. The port remains forwarded as long as the process is running. To stop forwarding the port, press Control+C.

gh codespace ports forward CODESPACE-PORT_NAME:LOCAL-PORT-NAME -c CODESPACE-NAME

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

You can set the visibility of a forwarded port. {% data reusables.codespaces.port-visibility-settings %}

gh codespace ports visibility CODESPACE-PORT:private|org|public -c CODESPACE-NAME

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

gh codespace ports visibility 80:private 3000:public 3306:org -c CODESPACE-NAME

For more information, see "AUTOTITLE."

Access codespace logs

You can see the creation log for a codespace. After entering this command you will be asked to enter the passphrase for your SSH key.

gh codespace logs -c CODESPACE-NAME

For more information about the creation log, see "AUTOTITLE."

Access remote resources

You can use the {% data variables.product.prodname_cli %} extension to create a bridge between a codespace and your local machine, so that the codespace can access any remote resource that is accessible from your machine. For more information on using the extension, see "Using {% data variables.product.prodname_cli %} to access remote resources."

{% note %}

Note: The {% data variables.product.prodname_cli %} extension is currently in beta and subject to change.

{% endnote %}

Change the machine type of a codespace

gh codespace edit -m MACHINE-TYPE-NAME

For more information, see the "{% data variables.product.prodname_cli %}" tab of "AUTOTITLE."