Saltar al contenido

¿Cómo usar GitHub CLI? [Beginner’s Tutorial]

GitHub Launches Command Line Tool

yoNo importa si es un principiante o un experto en desarrollo de software, todos los desarrolladores deben comprender y aprender a usar la plataforma de desarrollo de software líder en el mundo, GitHub. Hasta que se lanzó GitHub CLI Beta, solo se podía acceder a GitHub a través del navegador o la aplicación.

Pero ahora, no necesita usar un navegador para verificar los pequeños cambios realizados en el repositorio. Usando la herramienta de línea de comandos GitHub, gh, puede interactuar directamente con GUI GitHub desde su terminal local.

¿Qué es la CLI de GitHub?

Casi todos los desarrolladores usan Git para la colaboración de proyectos y GitHub para el alojamiento de código. Pero no existe una herramienta de línea de comandos para realizar funciones de GitHub desde un terminal.

Puede argumentar que ya existe una herramienta CLI Hub para el mismo. Pero déjenme aclarar que Hub es el contenedor que trae características adicionales de Git para facilitar una mejor experiencia de GitHub. Mientras que GitHub CLI es una herramienta independiente que adopta un enfoque diferente al de Hub y le permite ejecutar eventos de aplicaciones web de GitHub.

Antes de comenzar el tutorial, instalemos primero la CLI de GitHub.

¿Cómo instalar GitHub CLI?

Al momento de escribir este artículo, la CLI de GitHub está disponible en la versión beta v5.5.0 para macOS, Windows y Linux.

Para instalar la CLI de GitHub, puede ejecutar el comando:

en macOS

instalar brew github / gh / gh

en Windows

cucharada agregue github-gh https://github.com/cli/scoop-gh.git scoop install gh o choco install gh

en Linux

Puede descargar los archivos binarios precompilados desde aquí.

Crear y ver problemas con la CLI de GitHub

Para informar errores o mejoras en el proyecto, crea un problema y realiza un seguimiento del estado.

gh proporciona comandos para ver toda la información relacionado con el tema. Puede verificar todos los comandos disponibles para manipular con problemas.

problema de $ gh
Comandos relacionados con problemasComandos relacionados con problemas

Si quieres crear un problema, primero debe ir a la carpeta del proyecto y ejecutar el comando:

$ gh problema crear

Solicitará las entradas sobre el título y el cuerpo del problema.

Crear problemaCrea un problema

Después de ingresar los datos, puede elegir una opción para enviar el problema desde un terminal o navegador.

Problema de apertura en el navegador desde la terminalUn problema en un navegador abierto desde la terminal

Además, también puede crear un problema ingresando el título y el cuerpo con banderas.

Crear problema usando banderasCrea un problema usando banderas

Después de eso, puede enumerar todos los problemas y ver su estado con el comando:

Lista de problemas de $ gh

También puede filtrar la lista de problemas que pasan los indicadores, como el cesionario, la etiqueta, el estado y una serie de problemas como argumento para abrir un problema en particular.

Lista de problemas de $ gh (banderas)
Enumerar problemas con la etiqueta de filtroEnumerar problemas con la etiqueta de filtro

Aquí está la lista de indicadores que puede usar para filtrar problemas:

-a, --assignee string Filtrar por cesionario -B, --base string Filtrar por rama base -l, --label strings Filtrar por etiqueta -L, --limit int Número máximo de elementos para recuperar (valor predeterminado 30) -s , --state string Filtrar por estado: {abierto | cerrado | fusionado | todos} (predeterminado "abierto")

Ahora, como hemos creado y visto todos los problemas, también es necesario resolverlos. Por lo tanto, si alguien soluciona o actualiza el problema, podemos verificar los cambios realizados en cualquier problema utilizando varios indicadores, como URL o número.

ANUNCIO DE BANDERA CUADRADA DE CURSO CY C ++

Estado de emisión de $ gh
Ver el estado del problemaVer el estado del problema

Aquí, puede ver información mínima sobre los problemas. Pero si desea leer más información y también agregar una modificación, puede abrir el problema en el navegador directamente desde la terminal con el comando:

Vista de problema de $ gh (número de problema o url)

También puede usar el indicador de vista previa "–preview" o "-p" para ver el contenido en un terminal local.

Vista previa del contenido del problemaVista previa del contenido del problema

Cree, vea y finalice solicitudes de extracción con la CLI de GitHub

Otra funcionalidad GUI de GitHub que puedes manipular usando gh La herramienta CLI es la solicitud de extracción.

Puede contribuir a otro repositorio o trabajar en una nueva versión mediante la creación de una nueva rama y la solicitud de extracción para fusionar los nuevos cambios en la rama principal.

Para realizar esta acción, ahora puede usar el gh pr comando con un filtro directamente desde su terminal local.

Para la demostración, estoy creando una nueva sucursal uiy cambiar a una nueva sucursal para crear una solicitud de extracción para ui en el Maestro rama.

Para crear y cambiar a una nueva rama, puede usar el comando:

$ gh pr pago (nombre de sucursal)
Checkout pr branchPago a la sucursal de relaciones públicas

Ahora puede hacer algunos cambios en la nueva rama. Después de la modificación del archivo, cree una solicitud de extracción utilizando gh pr comando para fusionarse en el Maestro rama:

java-and-android-square-ad-1

$ gh pr create
Crear solicitud de extracciónCrear una solicitud de extracción

Además, si desea ingresar el título y el cuerpo en el comando, puede usar los indicadores "-t" para un título y "-b" para el texto del cuerpo.

Crear solicitud de extracción con banderasCrear solicitud de extracción con banderas

Ahora, cuando haya abierto la solicitud de extracción, el propietario del repositorio puede verificar la lista de las solicitudes de extracción junto con el filtro utilizando las banderas.

$ gh pr list (banderas)
Enumerar solicitudes de extracción con banderasEnumerar solicitudes de extracción con banderas

Además, si desea verificar si su PR está fusionado o requiere modificaciones, puede usar el siguiente comando para verificar el estado de PR:

$ gh pr status (banderas)
Verifique el estado de la solicitud de extracciónVerifique el estado de la solicitud de extracción

En el futuro, para la modificación o visualización del contenido de PR, puede abrir PR ya sea en el navegador o terminal.

$ gh por vista
Ver solicitud de extracciónVer solicitud de extracción

Un camino a seguir

La CLI de GitHub se encuentra actualmente en la etapa de desarrollo, por lo tanto, podemos esperar que se agreguen más características antes del lanzamiento de la primera versión.

Además de los problemas y las solicitudes de extracción, sería genial si GitHub agrega comandos para conectarse con el tablero del proyecto y las acciones de GitHub.