Sobre a CLI do GitHub Classroom
A GitHub CLI é uma ferramenta de código aberto para uso do GitHub na linha de comando do computador. Quando você está trabalhando na linha de comando, você pode usar GitHub CLI para economizar tempo e evitar mudar o contexto. Para saber mais, confira Sobre o a CLI do GitHub.
Você pode trabalhar com o GitHub Classroom na GitHub CLI para:
- Listar salas de aula
- Exibir informações da sala de aula
- Listar tarefas
- Listar as tarefas aceitas
- Exibir informações das tarefas
- Clonar o repositório de código inicial de uma tarefa
- Clonar o repositório de tarefas de um estudante
Como configurar a GitHub CLI
Para obter instruções de instalação para GitHub CLI, veja o repositório GitHub CLI.
Como usar a extensão GitHub Classroom com a GitHub CLI
Se você ainda não fez isso, execute gh auth login para se autenticar com sua conta do GitHub.
Para instalar a extensão GitHub Classroom, execute gh extension install github/gh-classroom.
Para usar o gh para trabalhar com o GitHub Classroom, digite gh classroom SUBCOMMAND.
Como exemplo de uma série de comandos que você pode usar para trabalhar com o GitHub Classroom, você pode:
- Liste as salas de aula:
gh classroom list - Liste as tarefas de uma sala de aula específica:
gh classroom assignments - Veja as informações de uma tarefa específica:
gh classroom assignment
Subcomandos do gh para o GitHub Classroom
Estas seções fornecem exemplos de subcomandos para cada uma das operações disponíveis. Quando aplicável, a CLI solicitará que você escolha uma sala de aula depois de executar o subcomando.
Na linha de comando, use gh classroom --help para obter ajuda geral ou gh classroom SUBCOMMAND --help para obter ajuda com um subcomando específico.
Listar salas de aula
gh classroom list
Lista de salas de aula que pertencem a você.
Exibir informações da sala de aula
gh classroom view
Exiba a ID da sala de aula, o campo de dados dinâmico da sala de aula, o título e outras informações sobre uma sala de aula.
Listar tarefas
gh classroom assignments
Veja uma lista de tarefas para uma sala de aula.
Listar as tarefas aceitas
gh classroom accepted-assignments
Veja uma lista de tarefas aceitas e informações sobre as tarefas do estudante.
Exibir informações das tarefas
gh classroom assignment
Exibe as informações da tarefa.
Clonar o repositório de código inicial de uma tarefa
gh classroom clone starter-repo
Clona o repositório de código inicial usado por uma tarefa. Por padrão, o código inicial é clonado no diretório atual. Para fazer a clonagem em outro diretório, use o sinalizador --directory. Se o diretório não existir, ele será criado.
Clonar o repositório de tarefas de um estudante
gh classroom clone student-repos
Clona os repositórios do estudante de determinada tarefa. Por padrão, os repositórios do estudante são clonados no diretório atual, um diretório que tem o mesmo nome do campo de dados dinâmico da tarefa. Para fazer a clonagem em outro diretório, use o sinalizador --directory. Se o diretório não existir, ele será criado.
Por padrão, todos os repositórios de estudantes são clonados. Para obter um número diferente de repositórios, use o sinalizador --per-page NUMBER.