Skip to main content

Inicio rápido de la CLI de GitHub

Comienza a utilizar el GitHub CLI para trabajar con GitHub en la línea de comandos.

Acerca de la GitHub CLI

GitHub CLI es una herramienta de código abierto para usar GitHub desde la línea de comandos del equipo. Cuando trabajas desde la línea de comandos, puedes utilizar el GitHub CLI para ahorrar tiempo y evitar cambiar de contexto.

Requisitos previos

  1. Instale GitHub CLI en macOS, Windows o Linux. Para obtener más información, consulte Instalación en el repositorio de GitHub CLI.

  2. Para autenticarte en GitHub, ejecuta el siguiente comando desde el terminal.

    gh auth login
    
  3. Selecciona dónde deseas autenticarte:

    • Si accedes a GitHub en GitHub.com, selecciona GitHub.com.
    • Si accedes a GitHub en un dominio diferente, selecciona Other y, a continuación, escribe tu nombre de host (por ejemplo: octocorp.ghe.com).
  4. Sigue el resto de las instrucciones que aparecen en pantalla.

    GitHub CLI almacena automáticamente sus credenciales de Git automáticamente cuando elija HTTPS como su protocolo preferido para las operaciones de Git y responda “yes” cuando le pregunten si quiere autenticarse en Git con sus credenciales GitHub. Esto puede ser útil, ya que permite usar comandos Git como git push y git pull sin necesidad de configurar un administrador de credenciales independiente o usar SSH.

Algunos comandos útiles

Nota:

Al usar algunos comandos por primera vez (por ejemplo, gh codespace SUBCOMMAND), se le pedirá que agregue ámbitos adicionales al token de autenticación. Siga las instrucciones en pantalla.

Visualización del estado

Escriba gh status para ver los detalles del trabajo actual en GitHub en todos los repositorios a los que está suscrito.

Vista de un repositorio

Escriba gh repo view OWNER/REPO para ver la descripción del repositorio y README.md para el repositorio. Escriba gh repo view OWNER/REPO --web para ver el repositorio en el explorador predeterminado.

Si ejecuta el subcomando repo desde el directorio de un repositorio de Git local que tiene un remoto en GitHub puede omitir OWNER/REPO.

Clonar un repositorio

Escriba gh repo clone OWNER/REPO. Por ejemplo, gh repo clone octo-org/octo-repo clona el repositorio octo-org/octo-repo en el directorio desde el que ejecutó este comando en el equipo local.

Crear un repositorio

Ingrese gh repo create y siga las instrucciones en pantalla. Puede crear un repositorio nuevo vacío en GitHub y luego, si así lo desea, clonarlo localmente. Como alternativa, puede insertar un repositorio local existente en GitHuby, opcionalmente, establecerlo como remoto para el repositorio local. Para obtener información sobre cómo establecer un directorio local como repositorio de Git, consulte Agregar código hospedado localmente a GitHub.

Trabajar con problemas

Escriba gh issue list --repo OWNER/REPO para enumerar los problemas creados más recientemente que estén abiertos en el momento para el repositorio especificado. Si ejecuta el subcomando issue desde el directorio de un repositorio de Git local que tiene un remoto en GitHub puede omitir --repo OWNER/REPO. Por ejemplo, escriba gh issue list --assignee "@me" para enumerar los problemas asignados en este repositorio o gh issue list --author monalisa para enumerar los problemas creados por el usuario “monalisa”.

También puede crear un problema, consulte Crear un problema o busque un problema, consulte Filtrar y buscar propuestas y solicitudes de cambios.

Trabajar con solicitudes de incorporación de cambios.

Escriba gh pr list --repo OWNER/REPO para enumerar las solicitudes de incorporación de cambio creadas más recientemente que estén abiertas en el momento para el repositorio especificado. Si ejecuta el subcomando pr desde el directorio de un repositorio de Git local que tiene un remoto en GitHub puede omitir --repo OWNER/REPO. Por ejemplo, escriba gh pr list --author "@me" para enumerar las solicitudes de incorporación de cambios abiertas que creó en este repositorio.

Escriba gh pr list --label LABEL-NAME para mostrar las solicitudes de incorporación de cambios abiertas con una etiqueta específica. Escriba gh search prs --review-requested=@me --state=open para enumerar las solicitudes de incorporación de cambios que se le ha solicitado que revise.

Para crear una solicitud de incorporación de cambios, escriba gh pr create y siga las instrucciones en pantalla. Para más información, consulta Crear una solicitud de incorporación de cambios.

Trabajar con codespaces

Para crear un nuevo codespace, escriba gh codespace create y siga las instrucciones en pantalla.

Para mostrar los codespaces existentes, escriba gh codespace list. Para abrir un codespace en la versión web de VS Code escriba gh codespace code -w y elija un codespace.

En todos estos comandos, puede sustituir cs por codespace.

Ayuda

Escriba gh para obtener un recordatorio de los comandos superiores GitHub CLI que puede usar. Por ejemplo, issue, pr, repo, etc.

Para cada comando y cada subcomando subsidiario, puede anexar la marca --help para averiguar cómo se usa. Por ejemplo, gh issue --help o gh issue create --help.

Personalizar GitHub CLI

Puede cambiar las opciones de configuración y agregar alias o extensiones para que GitHub CLI funcione de la manera más adecuada.

  • Escriba gh config set SUBCOMMANDS para configurar los valores de GitHub CLI, reemplazando SUBCOMMANDS por la configuración que desea ajustar.

    Por ejemplo, puede especificar el editor de texto que se usa cuando un comando GitHub CLI requiere que edite texto, como por ejemplo al agregar el texto del cuerpo para un nuevo problema que está creando. Para establecer el editor de texto preferido en Visual Studio Code ingrese gh config set editor "code -w". La marca -w (o --wait) de este ejemplo hace que el comando espere a que el archivo se cierre en Visual Studio Code antes de continuar con el paso siguiente en su terminal.

    Para obtener más información, vea gh config set.

  • Define los alias para los comandos que ejecutas comunmente. Por ejemplo, si ejecuta gh alias set prd "pr create --draft", después podrá ejecutar gh prd para abrir rápidamente una solicitud de incorporación de cambios de borrador. Para obtener más información, vea gh alias.

  • Crea o agrega comandos personalizados con las extensiones de GitHub CLI. Para obtener más información, vea Uso de extensiones de la CLI de GitHub y Creación de extensiones de la CLI de GitHub.

Uso de GitHub CLI con varias cuentas

Si tiene varias cuentas en la misma plataforma GitHub, como GitHub.com, puede autenticarse en cada una de ellas y cambiar entre ellas mediante el comando gh auth switch. Consulte gh auth switch en el manual de GitHub CLI.

Si necesita usar GitHub CLI en múltiples plataformas de GitHub, como una cuenta personal en GitHub.com y un cuenta de usuario administrada en GHE.com, consulte Uso de la CLI de GitHub en plataformas de GitHub.

Información adicional

  •         [AUTOTITLE](/github-cli/github-cli/github-cli-reference)
    
  •         [GitHub CLI manual en línea](https://cli.github.com/manual/gh)