Краткое руководство по GitHub CLI

Можно использовать GitHub CLI для работы с GitHub в командной строке.

В этой статье

Сведения о GitHub CLI

GitHub CLI — это инструмент с открытым исходным кодом для использования GitHub из командной строки компьютера. При работе с командной строкой можно использовать GitHub CLI — это позволит экономить время и не переключать контекст.

Необходимые компоненты

  1. Установите GitHub CLI в macOS, Windows или Linux. Дополнительные сведения см. в разделе "Установка " в репозитории GitHub CLI.

  2. Чтобы выполнить проверку подлинности в GitHub, выполните следующую команду из терминала.

    gh auth login

  3. Выберите место для проверки подлинности:

    • Если вы обращаетесь к GitHub по адресу GitHub.com, выберите GitHub.com.
    • Если вы обращаетесь к GitHub в другом домене, выберите "Другой", а затем введите имя узла (например: octocorp.ghe.com).

  4. Следуйте остальным запросам на экране.

    GitHub CLI автоматически сохраняет учетные данные Git при выборе HTTPS в качестве предпочтительного протокола для операций Git и ответить "да" запросу на запрос, хотите ли пройти проверку подлинности в Git с помощью учетных данных GitHub учетных данных. Это может быть полезно, так как это позволяет использовать такие команды Git, как git push и git pull без необходимости настраивать отдельный диспетчер учетных данных или использовать SSH.

Некоторые полезные команды

Примечание.

При первом использовании некоторых команд , например, gh codespace SUBCOMMAND вам будет предложено добавить дополнительные области в маркер проверки подлинности. Следуйте инструкциям на экране.

Просмотр состояния

Введите gh status сведения о текущей работе с GitHub во всех репозиториях, на которые вы подписаны.

Просмотр репозитория

Введите gh repo view OWNER/REPO , чтобы просмотреть описание репозитория и README.md репозиторий. Введите gh repo view OWNER/REPO --web , чтобы просмотреть репозиторий в браузере по умолчанию.

Если вы запускаете repo подкоманда из каталога локального репозитория Git, который имеет удаленный доступ к GitHub можно пропустить OWNER/REPO.

Клонирование репозитория

Введите gh repo clone OWNER/REPO. Например, клонирует репозиторий gh repo clone octo-org/octo-repo в каталог, octo-org/octo-repo из которого вы выполнили эту команду на локальном компьютере.

Создание репозитория

Введите gh repo create и следуйте инструкциям на экране. Вы можете создать новый пустой репозиторий на GitHub, а затем, при необходимости, клонировать его локально. Кроме того, можно отправить существующий локальный репозиторий в GitHubи при необходимости задать его как удаленный для локального репозитория. Сведения о настройке локального каталога в качестве репозитория Git см. в разделе Добавление локально размещенного кода в GitHub.

Работа с проблемами

Введите gh issue list --repo OWNER/REPO список последних созданных проблем, которые в настоящее время открыты для указанного репозитория. Если вы запускаете issue подкоманда из каталога локального репозитория Git, который имеет удаленный доступ к GitHub можно пропустить --repo OWNER/REPO. Например, введите gh issue list --assignee "@me" список проблем, назначенных вам в этом репозитории, или gh issue list --author monalisa перечислить проблемы, созданные пользователем monalisa.

Вы также можете создать новую проблему, просмотреть [AUTOTITLE или найти проблему, см. раздел AUTOTITLE](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests?tool=cli#searching-for-issues-and-pull-requests).

Работа с запросами на вытягивание

Введите gh pr list --repo OWNER/REPO список последних созданных запросов на вытягивание, которые в настоящее время открыты для указанного репозитория. Если вы запускаете pr подкоманда из каталога локального репозитория Git, который имеет удаленный доступ к GitHub можно пропустить --repo OWNER/REPO. Например, введите gh pr list --author "@me" список открытых запросов на вытягивание, созданные в этом репозитории.

Введите gh pr list --label LABEL-NAME список открытых запросов на вытягивание с определенной меткой. Введите gh search prs --review-requested=@me --state=open список запросов на вытягивание, которые вам было предложено проверить.

Чтобы создать запрос на вытягивание, введите gh pr create и следуйте инструкциям на экране. Дополнительные сведения см. в разделе Создание запроса на включение изменений.

Работа с пространствами кода

Чтобы создать новое пространство кода, введите gh codespace create и следуйте инструкциям на экране.

Чтобы отобразить существующие пространства кода, введите gh codespace list. Чтобы открыть кодовое пространство в веб-версии VS Code, введите gh codespace code -w и выберите кодовое пространство.

Во всех этих командах можно заменить cs``codespace.

Получение справки

Введите gh напоминание о командах верхнего уровня GitHub CLI, которые можно использовать. Например, issue, pr, repo и т. д.

Для каждой команды и каждого дочернего подкоманда можно добавить --help флаг, чтобы узнать, как он используется. Например, gh issue --help или gh issue create --help.

Настройка GitHub CLI

Вы можете изменить параметры конфигурации и добавить псевдонимы или расширения, чтобы сделать GitHub CLI работать так, как лучше всего подходит вам.

  • Введите gh config set SUBCOMMANDS , чтобы настроить параметры GitHub CLI, заменив SUBCOMMANDS параметры, которые необходимо настроить.

    Например, можно указать текстовый редактор, используемый при выполнении команды GitHub CLI для редактирования текста, например при добавлении текста для создаваемой проблемы. Чтобы задать для предпочтительного текстового редактора значение Visual Studio Code введите gh config set editor "code -w". Флаг -w (или --wait) в этом примере приводит к тому, что команда ожидает закрытия файла в Visual Studio Code перед продолжением следующего шага в терминале.

    Дополнительные сведения см. в разделе gh config set.

  • Определите псевдонимы для часто выполняемых команд. Например, если выполнить команду gh alias set prd "pr create --draft", затем для быстрого открытия черновика запроса на включение внесенных изменений можно будет использовать команду gh prd. Дополнительные сведения см. в разделе gh alias.

  • Создайте или добавьте пользовательские команды с помощью расширений GitHub CLI. Дополнительные сведения см. в разделе [AUTOTITLE и Использование расширений GitHub CLI](/github-cli/github-cli/creating-github-cli-extensions).

Использование GitHub CLI с несколькими учетными записями

Если у вас есть несколько учетных записей на одной платформе GitHub, например GitHub.com, вы можете пройти проверку подлинности в каждом из них и переключиться между ними с помощью gh auth switch команды. См . параметр проверки подлинности в руководстве GitHub CLI вручную.

Если вам нужно использовать GitHub CLI на нескольких платформах GitHub, например личная учетная запись на GitHub.com и управляемая учетная запись пользователя на GHE.com, см. раздел AUTOTITLE.

Дополнительные материалы

  •         [AUTOTITLE](/github-cli/github-cli/github-cli-reference)

  •         [GitHub CLI вручную](https://cli.github.com/manual/gh)