About CLI de GitHub
CLI de GitHub es una herramienta de código abierto para utilizar GitHub desde la línea de comandos de tu computadora. Cuando trabajas desde la línea de comandos, puedes utilizar el CLI de GitHub para ahorrar tiempo y evitar cambiar de contexto. For more information, see "About CLI de GitHub."
You can work with Codespaces in the CLI de GitHub to:
- List your codespaces
- Create a codespace
- Stop a codespace
- Delete a codespace
- SSH into a codespace
- Open a codespace in Visual Studio Code
- Open a codespace in JupyterLab
- Copying a file to/from a codespace
- Modify ports in a codespace
- Access codespace logs
Installing CLI de GitHub
Para encontrar instrucciones de instalación para el CLI de GitHub, consulta el Repositorio del CLI de GitHub.
Using CLI de GitHub
If you have not already done so, run gh auth login
to authenticate with your GitHub account.
To use gh
to work with Codespaces, type gh codespace <COMMAND>
or its alias gh cs <COMMAND>
.
As an example of a series of commands you might use to work with Acerca de 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 mona-github-docs-v4qxrv7rfwv9w
- Forward a port to your local machine:
gh codespace ports forward 8000:8000 -c mona-github-docs-v4qxrv7rfwv9w
gh
commands for Acerca de GitHub Codespaces
The sections below give example commands for each of the available operations.
For a complete reference of gh
commands for Acerca de GitHub Codespaces, including details of all available options for each command, see the CLI de GitHub online help for "gh codespace." Alternatively, use gh codespace [<SUBCOMMAND>...] --help
on the command line.
Note: The -c <em>codespace-name</em>
flag, used with many commands, is optional. If you omit it a list of codespaces is displayed for you to choose from.
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.
Create a new codespace
gh codespace create -r owner/repository [-b branch]
For more information, see "Creating a codespace."
Stop a codespace
gh codespace stop -c codespace-name
For more information, see "Deep dive into Codespaces."
Delete a codespace
gh codespace delete -c codespace-name
For more information, see "Deleting a codespace."
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
Acerca de GitHub Codespaces copies your GitHub SSH keys into the codespace on creation for a seamless authentication experience. You may be asked to enter the passphrase for your SSH key, after which you will get a command prompt from the remote codespace machine.
If you don't have any SSH keys, follow the instructions in "Generating a new SSH key and adding it to the ssh-agent."
Open a codespace in Visual Studio Code
gh codespace code -c codespace-name
For more information, see "Using Codespaces in Visual Studio Code."
Open a codespace in JupyterLab
gh codespace jupyter -c codespace-name
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 CLI de GitHub 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-number:local-port-number -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. Existen tres ajustes de visibilidad:
private
- Visible solo para ti. Este es el ajuste predeterminado cuando reenvías un puerto.org
- Visible para los miembros de la organización que son propietarios del repositorio.public
- Visible para cualquiera que conozca la URL y número de puerto.
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 "Forwarding ports in your codespace."
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 "Codespaces logs."