---
title: 'Using {% data variables.product.prodname_classroom %} with {% data variables.product.prodname_cli %}'
shortTitle: '{% data variables.product.prodname_classroom %} CLI'
allowTitleToDifferFromFilename: true
intro: 'You can use `gh`, the {% data variables.product.product_name %} command line interface, to work with {% data variables.product.prodname_classroom %} directly from your command line.'
versions:
  fpt: '*'
type: how_to
---

## About {% data variables.product.prodname_classroom %} CLI <!-- omit in toc -->

{% data reusables.cli.about-cli %} For more information, see "[AUTOTITLE](/github-cli/github-cli/about-github-cli)."

You can work with {% data variables.product.prodname_classroom %} in the  {% data variables.product.prodname_cli %} to:

* [List classrooms](#list-classrooms)
* [View classroom information](#view-classroom-information)
* [List assignments](#list-assignments)
* [List accepted assignments](#list-accepted-assignments)
* [View assignment information](#view-assignment-information)
* [Clone an assignment's starter code repository](#clone-an-assignments-starter-code-repository)
* [Clone a student’s assignment repository](#clone-a-students-assignment-repository)

## Setting up {% data variables.product.prodname_cli %} <!-- omit in toc -->

{% data reusables.cli.cli-installation %}

## Using the {% data variables.product.prodname_classroom %} extension with {% data variables.product.prodname_cli %} <!-- omit in toc -->

If you have not already done so, run `gh auth login` to authenticate with your {% data variables.product.prodname_dotcom %} account.

To install the {% data variables.product.prodname_classroom %} extension, run `gh extension install github/gh-classroom`.

To use `gh` to work with {% data variables.product.prodname_classroom %}, type `gh classroom SUBCOMMAND`.

As an example of a series of commands you might use to work with {% data variables.product.prodname_classroom %}, you could:
* List your classrooms:<br>
  `gh classroom list`
* List the assignments for a specific classroom:<br>
  `gh classroom assignments`
* View information for a specific assignment:<br>
  `gh classroom assignment`

## `gh` subcommands for {% data variables.product.prodname_classroom %} <!-- omit in toc -->

These sections give example subcommands for each of the available operations. {% data reusables.classroom.classroom-cli-prompt %}

On the command line, use `gh classroom --help` for general help or `gh classroom SUBCOMMAND --help` for help with a specific subcommand.

### List classrooms

```shell
gh classroom list
```

List of classrooms you own.

### View classroom information

```shell
gh classroom view
```

Display the classroom ID, classroom slug, title, and other information about a classroom.

### List assignments

```shell
gh classroom assignments
```

Display a list of assignments for a classroom.

### List accepted assignments

```shell
gh classroom accepted-assignments
```

Display a list of accepted assignments and information about the student's assignments.

### View assignment information

```shell
gh classroom assignment
```

Displays assignment information.

### Clone an assignment's starter code repository

```shell
gh classroom clone starter-repo
```

Clones starter code repo used by an assignment. By default, the starter code is cloned into the current directory. To clone into a different directory, use the `--directory` flag. If the directory does not exists, it will be created.

### Clone a student’s assignment repository

```shell
gh classroom clone student-repos
```

Clones student repositories from a given assignment. By default, the student repositories are cloned into the current directory a directory named after the assignment slug. To clone into a different directory, use the `--directory` flag. If the directory does not exists, it will be created.

By default, all student repositories are cloned. To get a different number of repositories, use the `--per-page NUMBER` flag.