Acerca de la CLI de GitHub Classroom
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. Para más información, consulta Acerca del CLI de GitHub.
Puedes trabajar con GitHub Classroom en la GitHub CLI para:
- Enumerar las clases
- Ver información de la clase
- Enumerar las asignaciones
- Enumerar las asignaciones aceptadas
- Ver información de la asignación
- Clonar el repositorio de código de inicio de una asignación
- Clonar el repositorio de asignaciones de un alumno
Configuración de GitHub CLI
A fin de obtener instrucciones de instalación para GitHub CLI, vea el repositorio de GitHub CLI.
Uso de la extensión GitHub Classroom con GitHub CLI
Si todavía no lo ha hecho, ejecute gh auth login para autenticarse con la cuenta de GitHub.
Para instalar la extensión GitHub Classroom, ejecuta gh extension install github/gh-classroom.
Para usar gh para trabajar con GitHub Classroom, escribe gh classroom SUBCOMMAND.
Como ejemplo de una serie de comandos que puedes usar para trabajar con GitHub Classroom, puedes:
- Enumerar las clases:
gh classroom list - Enumerar las asignaciones de una clase específica:
gh classroom assignments - Ver información de una asignación específica:
gh classroom assignment
Subcomandos gh para GitHub Classroom
En estas secciones se proporcionan subcomandos de ejemplo para cada una de las operaciones disponibles. Cuando corresponda, la CLI te pedirá elegir una clase después de ejecutar el subcomando.
En la línea de comandos, usa gh classroom --help para obtener ayuda general o gh classroom SUBCOMMAND --help para obtener ayuda con un subcomando específico.
Enumerar las clases
gh classroom list
Lista de las clases que te pertenecen.
Ver información de la clase
gh classroom view
Muestra el identificador de clase, el slug de la clase, el título y otra información sobre una clase.
Enumerar las asignaciones
gh classroom assignments
Muestra una lista de asignaciones para una clase.
Enumerar las asignaciones aceptadas
gh classroom accepted-assignments
Muestra una lista de las asignaciones aceptadas e información sobre las asignaciones del alumno.
Ver información de la asignación
gh classroom assignment
Muestra información de la asignación.
Clonar el repositorio de código de inicio de una asignación
gh classroom clone starter-repo
Clona el repositorio de código de inicio que utiliza una asignación. De forma predeterminada, el código de inicio se clona en el directorio actual. Para clonar en otro directorio, usa la marca --directory. Si el directorio no existe, se creará.
Clonar el repositorio de asignaciones de un alumno
gh classroom clone student-repos
Clona repositorios de los alumnos de una asignación determinada. De manera predeterminada, los repositorios de los alumnos se clonan en el directorio actual, que toma su nombre del campo de datos dinámico de la asignación. Para clonar en otro directorio, usa la marca --directory. Si el directorio no existe, se creará.
De manera predeterminada, se clonan todos los repositorios de alumnos. Para obtener un número diferente de repositorios, usa la marca --per-page NUMBER.