À propos de l’interface CLI de GitHub Classroom
GitHub CLI est un outil open source permettant d’utiliser GitHub à partir de la ligne de commande de votre ordinateur. Lorsque vous travaillez à partir de la ligne de commande, vous pouvez utiliser l’GitHub CLI pour gagner du temps et éviter de changer de contexte. Pour plus d’informations, consultez À propos de GitHub CLI.
Vous pouvez utiliser GitHub Classroom dans l’GitHub CLI pour :
- Lister les classes
- Afficher les informations sur les classes
- Lister les devoirs
- Lister les devoirs acceptés
- Afficher les informations sur les devoirs
- Cloner le dépôt de code de démarrage d’un devoir
- Cloner le dépôt de devoirs d’un étudiant
Configuration de l’GitHub CLI
Pour obtenir des instructions d’installation pour GitHub CLI, consultez le dépôt GitHub CLI.
Utilisation de l’extension GitHub Classroom avec l’GitHub CLI
Si vous ne l’avez déjà fait, exécutez gh auth login pour vous authentifier auprès de votre compte GitHub.
Pour installer l’extension GitHub Classroom, exécutez gh extension install github/gh-classroom.
Pour utiliser gh avec GitHub Classroom, tapez gh classroom SUBCOMMAND.
En guise d’exemple de série de commandes que vous pourriez utiliser avec GitHub Classroom, vous pouvez :
- Lister vos classes :
gh classroom list - Répertorier les devoirs d’une classe spécifique :
gh classroom assignments - Afficher les informations d’un devoir spécifique :
gh classroom assignment
Sous-commandes gh pour GitHub Classroom
Ces sections donnent des exemples de sous-commandes pour chacune des opérations disponibles. Le cas échéant, l’interface CLI vous invite à choisir une salle de classe après avoir exécuté la sous-commande.
Sur la ligne de commande, vous pouvez utiliser gh classroom --help pour obtenir une aide générale ou gh classroom SUBCOMMAND --help pour obtenir une aide sur une sous-commande spécifique.
Lister les classes
gh classroom list
Liste les classes que vous possédez.
Afficher les informations sur les classes
gh classroom view
Affiche l’ID de classe, le slug de classe, le titre et d’autres informations sur une classe.
Lister les devoirs
gh classroom assignments
Affiche la liste des devoirs d’une classe.
Lister les devoirs acceptés
gh classroom accepted-assignments
Affiche la liste des devoirs acceptés et des informations sur les devoirs de l’étudiant.
Afficher les informations sur les devoirs
gh classroom assignment
Affiche les informations sur les devoirs.
Cloner le dépôt de code de démarrage d’un devoir
gh classroom clone starter-repo
Clone le dépôt de code de démarrage utilisé par un devoir. Par défaut, le code de démarrage est cloné dans le répertoire actif. Pour cloner dans un autre répertoire, utilisez l’indicateur --directory. Si le répertoire n’existe pas, il est créé.
Cloner le dépôt de devoirs d’un étudiant
gh classroom clone student-repos
Clone les dépôts d’un étudiant à partir d’un devoir donné. Par défaut, les référentiels des étudiants sont clonés dans le répertoire actif, un répertoire nommé d’après le champ de données dynamiques assigné. Pour cloner dans un autre répertoire, utilisez l’indicateur --directory. Si le répertoire n’existe pas, il est créé.
Par défaut, tous les référentiels des étudiants sont clonés. Pour obtenir un autre nombre de référentiels, utilisez l’indicateur --per-page NUMBER.