Быстрый старт GitHub CLI

Сведения о GitHub CLI

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

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

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

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

Введите 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.

Вы также можете создать новый выпуск, см. Создание проблемы или поискать проблему, см. Фильтрация и поиск проблем и запросов на вытягивание.

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

Введите 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. Для получения дополнительной информации см. Использование расширений GitHub CLI и Создание расширений GitHub CLI.

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

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

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

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

•         [автозаголовок](/github-cli/github-cli/github-cli-reference)
  

•         [GitHub CLI онлайн-руководство](https://cli.github.com/manual/gh)