From a68af37cc10d53ad35ce54e7ee6a74f3308a80ea Mon Sep 17 00:00:00 2001 From: Web4 <167559384+Web4application@users.noreply.github.com> Date: Mon, 26 May 2025 18:24:20 +0200 Subject: [PATCH 0001/1047] Add files via upload (#2) --- Main/gh-release.1 | 71 +++++++++ Main/gh-repo-archive.1 | 42 ++++++ Main/gh-repo-autolink-create.1 | 82 ++++++++++ Main/gh-repo-autolink-delete.1 | 45 ++++++ Main/gh-repo-autolink-list.1 | 68 +++++++++ Main/gh-repo-autolink-view.1 | 57 +++++++ Main/gh-repo-autolink.1 | 64 ++++++++ Main/gh-repo-clone.1 | 79 ++++++++++ Main/gh-repo-create.1 | 154 +++++++++++++++++++ Main/gh-repo-delete.1 | 46 ++++++ Main/gh-repo-deploy-key-add.1 | 63 ++++++++ Main/gh-repo-deploy-key-delete.1 | 35 +++++ Main/gh-repo-deploy-key-list.1 | 57 +++++++ Main/gh-repo-deploy-key.1 | 49 ++++++ Main/gh-repo-edit.1 | 155 +++++++++++++++++++ Main/gh-repo-fork.1 | 74 +++++++++ Main/gh-repo-gitignore-list.1 | 33 ++++ Main/gh-repo-gitignore-view.1 | 56 +++++++ Main/gh-repo-gitignore.1 | 39 +++++ Main/gh-repo-license-list.1 | 41 +++++ Main/gh-repo-license-view.1 | 63 ++++++++ Main/gh-repo-license.1 | 39 +++++ Main/gh-repo-list.1 | 92 ++++++++++++ Main/gh-repo-rename.1 | 70 +++++++++ Main/gh-repo-set-default.1 | 74 +++++++++ Main/gh-repo-sync.1 | 75 ++++++++++ Main/gh-repo-unarchive.1 | 42 ++++++ Main/gh-repo-view.1 | 68 +++++++++ Main/gh-repo.1 | 110 ++++++++++++++ Main/gh-ruleset-check.1 | 80 ++++++++++ Main/gh-ruleset-list.1 | 87 +++++++++++ Main/gh-ruleset-view.1 | 82 ++++++++++ Main/gh-ruleset.1 | 67 +++++++++ Main/gh-run-cancel.1 | 35 +++++ Main/gh-run-delete.1 | 46 ++++++ Main/gh-run-download.1 | 80 ++++++++++ Main/gh-run-list.1 | 104 +++++++++++++ Main/gh-run-rerun.1 | 69 +++++++++ Main/gh-run-view.1 | 117 +++++++++++++++ Main/gh-run-watch.1 | 64 ++++++++ Main/gh-run.1 | 69 +++++++++ Main/gh-search-code.1 | 120 +++++++++++++++ Main/gh-search-commits.1 | 159 ++++++++++++++++++++ Main/gh-search-issues.1 | 218 +++++++++++++++++++++++++++ Main/gh-search-prs.1 | 250 +++++++++++++++++++++++++++++++ Main/gh-search-repos.1 | 170 +++++++++++++++++++++ Main/gh-search.1 | 55 +++++++ Main/gh-secret-delete.1 | 65 ++++++++ Main/gh-secret-list.1 | 81 ++++++++++ Main/gh-secret-set.1 | 126 ++++++++++++++++ Main/gh-secret.1 | 56 +++++++ Main/gh-ssh-key-add.1 | 39 +++++ Main/gh-ssh-key-delete.1 | 35 +++++ Main/gh-ssh-key-list.1 | 33 ++++ Main/gh-ssh-key.1 | 47 ++++++ Main/gh-status.1 | 61 ++++++++ Main/gh-variable-delete.1 | 56 +++++++ Main/gh-variable-get.1 | 68 +++++++++ Main/gh-variable-list.1 | 72 +++++++++ Main/gh-variable-set.1 | 98 ++++++++++++ Main/gh-variable.1 | 58 +++++++ Main/gh-workflow-disable.1 | 39 +++++ Main/gh-workflow-enable.1 | 39 +++++ Main/gh-workflow-list.1 | 69 +++++++++ Main/gh-workflow-run.1 | 90 +++++++++++ Main/gh-workflow-view.1 | 60 ++++++++ Main/gh-workflow.1 | 61 ++++++++ Main/gh.1 | 158 +++++++++++++++++++ 68 files changed, 5226 insertions(+) create mode 100644 Main/gh-release.1 create mode 100644 Main/gh-repo-archive.1 create mode 100644 Main/gh-repo-autolink-create.1 create mode 100644 Main/gh-repo-autolink-delete.1 create mode 100644 Main/gh-repo-autolink-list.1 create mode 100644 Main/gh-repo-autolink-view.1 create mode 100644 Main/gh-repo-autolink.1 create mode 100644 Main/gh-repo-clone.1 create mode 100644 Main/gh-repo-create.1 create mode 100644 Main/gh-repo-delete.1 create mode 100644 Main/gh-repo-deploy-key-add.1 create mode 100644 Main/gh-repo-deploy-key-delete.1 create mode 100644 Main/gh-repo-deploy-key-list.1 create mode 100644 Main/gh-repo-deploy-key.1 create mode 100644 Main/gh-repo-edit.1 create mode 100644 Main/gh-repo-fork.1 create mode 100644 Main/gh-repo-gitignore-list.1 create mode 100644 Main/gh-repo-gitignore-view.1 create mode 100644 Main/gh-repo-gitignore.1 create mode 100644 Main/gh-repo-license-list.1 create mode 100644 Main/gh-repo-license-view.1 create mode 100644 Main/gh-repo-license.1 create mode 100644 Main/gh-repo-list.1 create mode 100644 Main/gh-repo-rename.1 create mode 100644 Main/gh-repo-set-default.1 create mode 100644 Main/gh-repo-sync.1 create mode 100644 Main/gh-repo-unarchive.1 create mode 100644 Main/gh-repo-view.1 create mode 100644 Main/gh-repo.1 create mode 100644 Main/gh-ruleset-check.1 create mode 100644 Main/gh-ruleset-list.1 create mode 100644 Main/gh-ruleset-view.1 create mode 100644 Main/gh-ruleset.1 create mode 100644 Main/gh-run-cancel.1 create mode 100644 Main/gh-run-delete.1 create mode 100644 Main/gh-run-download.1 create mode 100644 Main/gh-run-list.1 create mode 100644 Main/gh-run-rerun.1 create mode 100644 Main/gh-run-view.1 create mode 100644 Main/gh-run-watch.1 create mode 100644 Main/gh-run.1 create mode 100644 Main/gh-search-code.1 create mode 100644 Main/gh-search-commits.1 create mode 100644 Main/gh-search-issues.1 create mode 100644 Main/gh-search-prs.1 create mode 100644 Main/gh-search-repos.1 create mode 100644 Main/gh-search.1 create mode 100644 Main/gh-secret-delete.1 create mode 100644 Main/gh-secret-list.1 create mode 100644 Main/gh-secret-set.1 create mode 100644 Main/gh-secret.1 create mode 100644 Main/gh-ssh-key-add.1 create mode 100644 Main/gh-ssh-key-delete.1 create mode 100644 Main/gh-ssh-key-list.1 create mode 100644 Main/gh-ssh-key.1 create mode 100644 Main/gh-status.1 create mode 100644 Main/gh-variable-delete.1 create mode 100644 Main/gh-variable-get.1 create mode 100644 Main/gh-variable-list.1 create mode 100644 Main/gh-variable-set.1 create mode 100644 Main/gh-variable.1 create mode 100644 Main/gh-workflow-disable.1 create mode 100644 Main/gh-workflow-enable.1 create mode 100644 Main/gh-workflow-list.1 create mode 100644 Main/gh-workflow-run.1 create mode 100644 Main/gh-workflow-view.1 create mode 100644 Main/gh-workflow.1 create mode 100644 Main/gh.1 diff --git a/Main/gh-release.1 b/Main/gh-release.1 new file mode 100644 index 0000000..10933ec --- /dev/null +++ b/Main/gh-release.1 @@ -0,0 +1,71 @@ +.nh +.TH "GH-RELEASE" "1" "May 2025" "GitHub CLI 2.73.0" "GitHub CLI manual" + +.SH NAME +gh-release - Manage releases + + +.SH SYNOPSIS +\fBgh release [flags]\fR + + +.SH GENERAL COMMANDS +.TP +\fBgh-release-create(1)\fR +Create a new release + +.TP +\fBgh-release-list(1)\fR +List releases in a repository + + +.SH TARGETED COMMANDS +.TP +\fBgh-release-delete(1)\fR +Delete a release + +.TP +\fBgh-release-delete-asset(1)\fR +Delete an asset from a release + +.TP +\fBgh-release-download(1)\fR +Download release assets + +.TP +\fBgh-release-edit(1)\fR +Edit a release + +.TP +\fBgh-release-upload(1)\fR +Upload assets to a release + +.TP +\fBgh-release-view(1)\fR +View information about a release + + +.SH OPTIONS +.TP +\fB-R\fR, \fB--repo\fR \fB<[HOST/]OWNER/REPO>\fR +Select another repository using the [HOST/]OWNER/REPO format + + +.SH EXIT CODES +0: Successful execution + +.PP +1: Error + +.PP +2: Command canceled + +.PP +4: Authentication required + +.PP +NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information. + + +.SH SEE ALSO +\fBgh(1)\fR diff --git a/Main/gh-repo-archive.1 b/Main/gh-repo-archive.1 new file mode 100644 index 0000000..849fc47 --- /dev/null +++ b/Main/gh-repo-archive.1 @@ -0,0 +1,42 @@ +.nh +.TH "GH-REPO-ARCHIVE" "1" "May 2025" "GitHub CLI 2.73.0" "GitHub CLI manual" + +.SH NAME +gh-repo-archive - Archive a repository + + +.SH SYNOPSIS +\fBgh repo archive [] [flags]\fR + + +.SH DESCRIPTION +Archive a GitHub repository. + +.PP +With no argument, archives the current repository. + + +.SH OPTIONS +.TP +\fB-y\fR, \fB--yes\fR +Skip the confirmation prompt + + +.SH EXIT CODES +0: Successful execution + +.PP +1: Error + +.PP +2: Command canceled + +.PP +4: Authentication required + +.PP +NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information. + + +.SH SEE ALSO +\fBgh-repo(1)\fR diff --git a/Main/gh-repo-autolink-create.1 b/Main/gh-repo-autolink-create.1 new file mode 100644 index 0000000..51111a0 --- /dev/null +++ b/Main/gh-repo-autolink-create.1 @@ -0,0 +1,82 @@ +.nh +.TH "GH-REPO-AUTOLINK-CREATE" "1" "May 2025" "GitHub CLI 2.73.0" "GitHub CLI manual" + +.SH NAME +gh-repo-autolink-create - Create a new autolink reference + + +.SH SYNOPSIS +\fBgh repo autolink create [flags]\fR + + +.SH DESCRIPTION +Create a new autolink reference for a repository. + +.PP +The \fBkeyPrefix\fR argument specifies the prefix that will generate a link when it is appended by certain characters. + +.PP +The \fBurlTemplate\fR argument specifies the target URL that will be generated when the keyPrefix is found, which +must contain \fB\fR variable for the reference number. + +.PP +By default, autolinks are alphanumeric with \fB--numeric\fR flag used to create a numeric autolink. + +.PP +The \fB\fR variable behavior differs depending on whether the autolink is alphanumeric or numeric: +.IP \(bu 2 +alphanumeric: matches \fBA-Z\fR (case insensitive), \fB0-9\fR, and \fB-\fR +.IP \(bu 2 +numeric: matches \fB0-9\fR + +.PP +If the template contains multiple instances of \fB\fR, only the first will be replaced. + + +.SH OPTIONS +.TP +\fB-n\fR, \fB--numeric\fR +Mark autolink as numeric + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.TP +\fB-R\fR, \fB--repo\fR \fB<[HOST/]OWNER/REPO>\fR +Select another repository using the [HOST/]OWNER/REPO format + + +.SH ALIASES +gh repo autolink new + + +.SH EXIT CODES +0: Successful execution + +.PP +1: Error + +.PP +2: Command canceled + +.PP +4: Authentication required + +.PP +NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information. + + +.SH EXAMPLE +.EX +# Create an alphanumeric autolink to example.com for the key prefix "TICKET-". +# Generates https://example.com/TICKET?query=123abc from "TICKET-123abc". +$ gh repo autolink create TICKET- "https://example.com/TICKET?query=" + +# Create a numeric autolink to example.com for the key prefix "STORY-". +# Generates https://example.com/STORY?id=123 from "STORY-123". +$ gh repo autolink create STORY- "https://example.com/STORY?id=" --numeric + +.EE + + +.SH SEE ALSO +\fBgh-repo-autolink(1)\fR diff --git a/Main/gh-repo-autolink-delete.1 b/Main/gh-repo-autolink-delete.1 new file mode 100644 index 0000000..f04fe25 --- /dev/null +++ b/Main/gh-repo-autolink-delete.1 @@ -0,0 +1,45 @@ +.nh +.TH "GH-REPO-AUTOLINK-DELETE" "1" "May 2025" "GitHub CLI 2.73.0" "GitHub CLI manual" + +.SH NAME +gh-repo-autolink-delete - Delete an autolink reference + + +.SH SYNOPSIS +\fBgh repo autolink delete [flags]\fR + + +.SH DESCRIPTION +Delete an autolink reference for a repository. + + +.SH OPTIONS +.TP +\fB--yes\fR +Confirm deletion without prompting + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.TP +\fB-R\fR, \fB--repo\fR \fB<[HOST/]OWNER/REPO>\fR +Select another repository using the [HOST/]OWNER/REPO format + + +.SH EXIT CODES +0: Successful execution + +.PP +1: Error + +.PP +2: Command canceled + +.PP +4: Authentication required + +.PP +NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information. + + +.SH SEE ALSO +\fBgh-repo-autolink(1)\fR diff --git a/Main/gh-repo-autolink-list.1 b/Main/gh-repo-autolink-list.1 new file mode 100644 index 0000000..691ca94 --- /dev/null +++ b/Main/gh-repo-autolink-list.1 @@ -0,0 +1,68 @@ +.nh +.TH "GH-REPO-AUTOLINK-LIST" "1" "May 2025" "GitHub CLI 2.73.0" "GitHub CLI manual" + +.SH NAME +gh-repo-autolink-list - List autolink references for a GitHub repository + + +.SH SYNOPSIS +\fBgh repo autolink list [flags]\fR + + +.SH DESCRIPTION +Gets all autolink references that are configured for a repository. + +.PP +Information about autolinks is only available to repository administrators. + + +.SH OPTIONS +.TP +\fB-q\fR, \fB--jq\fR \fB\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB\fR +Output JSON with the specified fields + +.TP +\fB-t\fR, \fB--template\fR \fB\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB-w\fR, \fB--web\fR +List autolink references in the web browser + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.TP +\fB-R\fR, \fB--repo\fR \fB<[HOST/]OWNER/REPO>\fR +Select another repository using the [HOST/]OWNER/REPO format + + +.SH ALIASES +gh repo autolink ls + + +.SH JSON FIELDS +\fBid\fR, \fBisAlphanumeric\fR, \fBkeyPrefix\fR, \fBurlTemplate\fR + + +.SH EXIT CODES +0: Successful execution + +.PP +1: Error + +.PP +2: Command canceled + +.PP +4: Authentication required + +.PP +NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information. + + +.SH SEE ALSO +\fBgh-repo-autolink(1)\fR diff --git a/Main/gh-repo-autolink-view.1 b/Main/gh-repo-autolink-view.1 new file mode 100644 index 0000000..4476dd7 --- /dev/null +++ b/Main/gh-repo-autolink-view.1 @@ -0,0 +1,57 @@ +.nh +.TH "GH-REPO-AUTOLINK-VIEW" "1" "May 2025" "GitHub CLI 2.73.0" "GitHub CLI manual" + +.SH NAME +gh-repo-autolink-view - View an autolink reference + + +.SH SYNOPSIS +\fBgh repo autolink view [flags]\fR + + +.SH DESCRIPTION +View an autolink reference for a repository. + + +.SH OPTIONS +.TP +\fB-q\fR, \fB--jq\fR \fB\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB\fR +Output JSON with the specified fields + +.TP +\fB-t\fR, \fB--template\fR \fB\fR +Format JSON output using a Go template; see "gh help formatting" + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.TP +\fB-R\fR, \fB--repo\fR \fB<[HOST/]OWNER/REPO>\fR +Select another repository using the [HOST/]OWNER/REPO format + + +.SH JSON FIELDS +\fBid\fR, \fBisAlphanumeric\fR, \fBkeyPrefix\fR, \fBurlTemplate\fR + + +.SH EXIT CODES +0: Successful execution + +.PP +1: Error + +.PP +2: Command canceled + +.PP +4: Authentication required + +.PP +NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information. + + +.SH SEE ALSO +\fBgh-repo-autolink(1)\fR diff --git a/Main/gh-repo-autolink.1 b/Main/gh-repo-autolink.1 new file mode 100644 index 0000000..506e05d --- /dev/null +++ b/Main/gh-repo-autolink.1 @@ -0,0 +1,64 @@ +.nh +.TH "GH-REPO-AUTOLINK" "1" "May 2025" "GitHub CLI 2.73.0" "GitHub CLI manual" + +.SH NAME +gh-repo-autolink - Manage autolink references + + +.SH SYNOPSIS +\fBgh repo autolink [flags]\fR + + +.SH DESCRIPTION +Autolinks link issues, pull requests, commit messages, and release descriptions to external third-party services. + +.PP +Autolinks require \fBadmin\fR role to view or manage. + +.PP +For more information, see +\[la]https://docs.github.com/en/repositories/managing\-your\-repositorys\-settings\-and\-features/managing\-repository\-settings/configuring\-autolinks\-to\-reference\-external\-resources\[ra] + + +.SH AVAILABLE COMMANDS +.TP +\fBgh-repo-autolink-create(1)\fR +Create a new autolink reference + +.TP +\fBgh-repo-autolink-delete(1)\fR +Delete an autolink reference + +.TP +\fBgh-repo-autolink-list(1)\fR +List autolink references for a GitHub repository + +.TP +\fBgh-repo-autolink-view(1)\fR +View an autolink reference + + +.SH OPTIONS +.TP +\fB-R\fR, \fB--repo\fR \fB<[HOST/]OWNER/REPO>\fR +Select another repository using the [HOST/]OWNER/REPO format + + +.SH EXIT CODES +0: Successful execution + +.PP +1: Error + +.PP +2: Command canceled + +.PP +4: Authentication required + +.PP +NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information. + + +.SH SEE ALSO +\fBgh-repo(1)\fR diff --git a/Main/gh-repo-clone.1 b/Main/gh-repo-clone.1 new file mode 100644 index 0000000..94c2b9d --- /dev/null +++ b/Main/gh-repo-clone.1 @@ -0,0 +1,79 @@ +.nh +.TH "GH-REPO-CLONE" "1" "May 2025" "GitHub CLI 2.73.0" "GitHub CLI manual" + +.SH NAME +gh-repo-clone - Clone a repository locally + + +.SH SYNOPSIS +\fBgh repo clone [] [-- ...]\fR + + +.SH DESCRIPTION +Clone a GitHub repository locally. Pass additional \fBgit clone\fR flags by listing +them after \fB--\fR\&. + +.PP +If the \fBOWNER/\fR portion of the \fBOWNER/REPO\fR repository argument is omitted, it +defaults to the name of the authenticating user. + +.PP +When a protocol scheme is not provided in the repository argument, the \fBgit_protocol\fR will be +chosen from your configuration, which can be checked via \fBgh config get git_protocol\fR\&. If the protocol +scheme is provided, the repository will be cloned using the specified protocol. + +.PP +If the repository is a fork, its parent repository will be added as an additional +git remote called \fBupstream\fR\&. The remote name can be configured using \fB--upstream-remote-name\fR\&. +The \fB--upstream-remote-name\fR option supports an \fB@owner\fR value which will name +the remote after the owner of the parent repository. + +.PP +If the repository is a fork, its parent repository will be set as the default remote repository. + + +.SH OPTIONS +.TP +\fB-u\fR, \fB--upstream-remote-name\fR \fB (default "upstream")\fR +Upstream remote name when cloning a fork + + +.SH EXIT CODES +0: Successful execution + +.PP +1: Error + +.PP +2: Command canceled + +.PP +4: Authentication required + +.PP +NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information. + + +.SH EXAMPLE +.EX +# Clone a repository from a specific org +$ gh repo clone cli/cli + +# Clone a repository from your own account +$ gh repo clone myrepo + +# Clone a repo, overriding git protocol configuration +$ gh repo clone https://github.com/cli/cli +$ gh repo clone git@github.com:cli/cli.git + +# Clone a repository to a custom directory +$ gh repo clone cli/cli workspace/cli + +# Clone a repository with additional git clone flags +$ gh repo clone cli/cli -- --depth=1 + +.EE + + +.SH SEE ALSO +\fBgh-repo(1)\fR diff --git a/Main/gh-repo-create.1 b/Main/gh-repo-create.1 new file mode 100644 index 0000000..1de5de6 --- /dev/null +++ b/Main/gh-repo-create.1 @@ -0,0 +1,154 @@ +.nh +.TH "GH-REPO-CREATE" "1" "May 2025" "GitHub CLI 2.73.0" "GitHub CLI manual" + +.SH NAME +gh-repo-create - Create a new repository + + +.SH SYNOPSIS +\fBgh repo create [] [flags]\fR + + +.SH DESCRIPTION +Create a new GitHub repository. + +.PP +To create a repository interactively, use \fBgh repo create\fR with no arguments. + +.PP +To create a remote repository non-interactively, supply the repository name and one of \fB--public\fR, \fB--private\fR, or \fB--internal\fR\&. +Pass \fB--clone\fR to clone the new repository locally. + +.PP +If the \fBOWNER/\fR portion of the \fBOWNER/REPO\fR name argument is omitted, it +defaults to the name of the authenticating user. + +.PP +To create a remote repository from an existing local repository, specify the source directory with \fB--source\fR\&. +By default, the remote repository name will be the name of the source directory. + +.PP +Pass \fB--push\fR to push any local commits to the new repository. If the repo is bare, this will mirror all refs. + +.PP +For language or platform .gitignore templates to use with \fB--gitignore\fR, +\[la]https://github.com/github/gitignore\[ra]\&. + +.PP +For license keywords to use with \fB--license\fR, run \fBgh repo license list\fR or visit +\[la]https://choosealicense.com\[ra]\&. + +.PP +The repo is created with the configured repository default branch, see +\[la]https://docs.github.com/en/account\-and\-profile/setting\-up\-and\-managing\-your\-personal\-account\-on\-github/managing\-user\-account\-settings/managing\-the\-default\-branch\-name\-for\-your\-repositories\[ra]\&. + + +.SH OPTIONS +.TP +\fB--add-readme\fR +Add a README file to the new repository + +.TP +\fB-c\fR, \fB--clone\fR +Clone the new repository to the current directory + +.TP +\fB-d\fR, \fB--description\fR \fB\fR +Description of the repository + +.TP +\fB--disable-issues\fR +Disable issues in the new repository + +.TP +\fB--disable-wiki\fR +Disable wiki in the new repository + +.TP +\fB-g\fR, \fB--gitignore\fR \fB\fR +Specify a gitignore template for the repository + +.TP +\fB-h\fR, \fB--homepage\fR \fB\fR +Repository home page URL + +.TP +\fB--include-all-branches\fR +Include all branches from template repository + +.TP +\fB--internal\fR +Make the new repository internal + +.TP +\fB-l\fR, \fB--license\fR \fB\fR +Specify an Open Source License for the repository + +.TP +\fB--private\fR +Make the new repository private + +.TP +\fB--public\fR +Make the new repository public + +.TP +\fB--push\fR +Push local commits to the new repository + +.TP +\fB-r\fR, \fB--remote\fR \fB\fR +Specify remote name for the new repository + +.TP +\fB-s\fR, \fB--source\fR \fB\fR +Specify path to local repository to use as source + +.TP +\fB-t\fR, \fB--team\fR \fB\fR +The name of the organization team to be granted access + +.TP +\fB-p\fR, \fB--template\fR \fB\fR +Make the new repository based on a template repository + + +.SH ALIASES +gh repo new + + +.SH EXIT CODES +0: Successful execution + +.PP +1: Error + +.PP +2: Command canceled + +.PP +4: Authentication required + +.PP +NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information. + + +.SH EXAMPLE +.EX +# Create a repository interactively +$ gh repo create + +# Create a new remote repository and clone it locally +$ gh repo create my-project --public --clone + +# Create a new remote repository in a different organization +$ gh repo create my-org/my-project --public + +# Create a remote repository from the current directory +$ gh repo create my-project --private --source=. --remote=upstream + +.EE + + +.SH SEE ALSO +\fBgh-repo(1)\fR diff --git a/Main/gh-repo-delete.1 b/Main/gh-repo-delete.1 new file mode 100644 index 0000000..6d47a75 --- /dev/null +++ b/Main/gh-repo-delete.1 @@ -0,0 +1,46 @@ +.nh +.TH "GH-REPO-DELETE" "1" "May 2025" "GitHub CLI 2.73.0" "GitHub CLI manual" + +.SH NAME +gh-repo-delete - Delete a repository + + +.SH SYNOPSIS +\fBgh repo delete [] [flags]\fR + + +.SH DESCRIPTION +Delete a GitHub repository. + +.PP +With no argument, deletes the current repository. Otherwise, deletes the specified repository. + +.PP +Deletion requires authorization with the \fBdelete_repo\fR scope. +To authorize, run \fBgh auth refresh -s delete_repo\fR + + +.SH OPTIONS +.TP +\fB--yes\fR +Confirm deletion without prompting + + +.SH EXIT CODES +0: Successful execution + +.PP +1: Error + +.PP +2: Command canceled + +.PP +4: Authentication required + +.PP +NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information. + + +.SH SEE ALSO +\fBgh-repo(1)\fR diff --git a/Main/gh-repo-deploy-key-add.1 b/Main/gh-repo-deploy-key-add.1 new file mode 100644 index 0000000..8f4b097 --- /dev/null +++ b/Main/gh-repo-deploy-key-add.1 @@ -0,0 +1,63 @@ +.nh +.TH "GH-REPO-DEPLOY-KEY-ADD" "1" "May 2025" "GitHub CLI 2.73.0" "GitHub CLI manual" + +.SH NAME +gh-repo-deploy-key-add - Add a deploy key to a GitHub repository + + +.SH SYNOPSIS +\fBgh repo deploy-key add [flags]\fR + + +.SH DESCRIPTION +Add a deploy key to a GitHub repository. + +.PP +Note that any key added by gh will be associated with the current authentication token. +If you de-authorize the GitHub CLI app or authentication token from your account, any +deploy keys added by GitHub CLI will be removed as well. + + +.SH OPTIONS +.TP +\fB-w\fR, \fB--allow-write\fR +Allow write access for the key + +.TP +\fB-t\fR, \fB--title\fR \fB\fR +Title of the new key + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.TP +\fB-R\fR, \fB--repo\fR \fB<[HOST/]OWNER/REPO>\fR +Select another repository using the [HOST/]OWNER/REPO format + + +.SH EXIT CODES +0: Successful execution + +.PP +1: Error + +.PP +2: Command canceled + +.PP +4: Authentication required + +.PP +NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information. + + +.SH EXAMPLE +.EX +# Generate a passwordless SSH key and add it as a deploy key to a repository +$ ssh-keygen -t ed25519 -C "my description" -N "" -f ~/.ssh/gh-test +$ gh repo deploy-key add ~/.ssh/gh-test.pub + +.EE + + +.SH SEE ALSO +\fBgh-repo-deploy-key(1)\fR diff --git a/Main/gh-repo-deploy-key-delete.1 b/Main/gh-repo-deploy-key-delete.1 new file mode 100644 index 0000000..dfd34cf --- /dev/null +++ b/Main/gh-repo-deploy-key-delete.1 @@ -0,0 +1,35 @@ +.nh +.TH "GH-REPO-DEPLOY-KEY-DELETE" "1" "May 2025" "GitHub CLI 2.73.0" "GitHub CLI manual" + +.SH NAME +gh-repo-deploy-key-delete - Delete a deploy key from a GitHub repository + + +.SH SYNOPSIS +\fBgh repo deploy-key delete [flags]\fR + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.TP +\fB-R\fR, \fB--repo\fR \fB<[HOST/]OWNER/REPO>\fR +Select another repository using the [HOST/]OWNER/REPO format + + +.SH EXIT CODES +0: Successful execution + +.PP +1: Error + +.PP +2: Command canceled + +.PP +4: Authentication required + +.PP +NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information. + + +.SH SEE ALSO +\fBgh-repo-deploy-key(1)\fR diff --git a/Main/gh-repo-deploy-key-list.1 b/Main/gh-repo-deploy-key-list.1 new file mode 100644 index 0000000..9b4c6a6 --- /dev/null +++ b/Main/gh-repo-deploy-key-list.1 @@ -0,0 +1,57 @@ +.nh +.TH "GH-REPO-DEPLOY-KEY-LIST" "1" "May 2025" "GitHub CLI 2.73.0" "GitHub CLI manual" + +.SH NAME +gh-repo-deploy-key-list - List deploy keys in a GitHub repository + + +.SH SYNOPSIS +\fBgh repo deploy-key list [flags]\fR + + +.SH OPTIONS +.TP +\fB-q\fR, \fB--jq\fR \fB\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB\fR +Output JSON with the specified fields + +.TP +\fB-t\fR, \fB--template\fR \fB\fR +Format JSON output using a Go template; see "gh help formatting" + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.TP +\fB-R\fR, \fB--repo\fR \fB<[HOST/]OWNER/REPO>\fR +Select another repository using the [HOST/]OWNER/REPO format + + +.SH ALIASES +gh repo deploy-key ls + + +.SH JSON FIELDS +\fBcreatedAt\fR, \fBid\fR, \fBkey\fR, \fBreadOnly\fR, \fBtitle\fR + + +.SH EXIT CODES +0: Successful execution + +.PP +1: Error + +.PP +2: Command canceled + +.PP +4: Authentication required + +.PP +NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information. + + +.SH SEE ALSO +\fBgh-repo-deploy-key(1)\fR diff --git a/Main/gh-repo-deploy-key.1 b/Main/gh-repo-deploy-key.1 new file mode 100644 index 0000000..539117d --- /dev/null +++ b/Main/gh-repo-deploy-key.1 @@ -0,0 +1,49 @@ +.nh +.TH "GH-REPO-DEPLOY-KEY" "1" "May 2025" "GitHub CLI 2.73.0" "GitHub CLI manual" + +.SH NAME +gh-repo-deploy-key - Manage deploy keys in a repository + + +.SH SYNOPSIS +\fBgh repo deploy-key [flags]\fR + + +.SH AVAILABLE COMMANDS +.TP +\fBgh-repo-deploy-key-add(1)\fR +Add a deploy key to a GitHub repository + +.TP +\fBgh-repo-deploy-key-delete(1)\fR +Delete a deploy key from a GitHub repository + +.TP +\fBgh-repo-deploy-key-list(1)\fR +List deploy keys in a GitHub repository + + +.SH OPTIONS +.TP +\fB-R\fR, \fB--repo\fR \fB<[HOST/]OWNER/REPO>\fR +Select another repository using the [HOST/]OWNER/REPO format + + +.SH EXIT CODES +0: Successful execution + +.PP +1: Error + +.PP +2: Command canceled + +.PP +4: Authentication required + +.PP +NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information. + + +.SH SEE ALSO +\fBgh-repo(1)\fR diff --git a/Main/gh-repo-edit.1 b/Main/gh-repo-edit.1 new file mode 100644 index 0000000..07c6a4d --- /dev/null +++ b/Main/gh-repo-edit.1 @@ -0,0 +1,155 @@ +.nh +.TH "GH-REPO-EDIT" "1" "May 2025" "GitHub CLI 2.73.0" "GitHub CLI manual" + +.SH NAME +gh-repo-edit - Edit repository settings + + +.SH SYNOPSIS +\fBgh repo edit [] [flags]\fR + + +.SH DESCRIPTION +Edit repository settings. + +.PP +To toggle a setting off, use the \fB--=false\fR syntax. + +.PP +Changing repository visibility can have unexpected consequences including but not limited to: +.IP \(bu 2 +Losing stars and watchers, affecting repository ranking +.IP \(bu 2 +Detaching public forks from the network +.IP \(bu 2 +Disabling push rulesets +.IP \(bu 2 +Allowing access to GitHub Actions history and logs + +.PP +When the \fB--visibility\fR flag is used, \fB--accept-visibility-change-consequences\fR flag is required. + +.PP +For information on all the potential consequences, see +\[la]https://gh.io/setting\-repository\-visibility\[ra]\&. + + +.SH OPTIONS +.TP +\fB--accept-visibility-change-consequences\fR +Accept the consequences of changing the repository visibility + +.TP +\fB--add-topic\fR \fB\fR +Add repository topic + +.TP +\fB--allow-forking\fR +Allow forking of an organization repository + +.TP +\fB--allow-update-branch\fR +Allow a pull request head branch that is behind its base branch to be updated + +.TP +\fB--default-branch\fR \fB\fR +Set the default branch name for the repository + +.TP +\fB--delete-branch-on-merge\fR +Delete head branch when pull requests are merged + +.TP +\fB-d\fR, \fB--description\fR \fB\fR +Description of the repository + +.TP +\fB--enable-advanced-security\fR +Enable advanced security in the repository + +.TP +\fB--enable-auto-merge\fR +Enable auto-merge functionality + +.TP +\fB--enable-discussions\fR +Enable discussions in the repository + +.TP +\fB--enable-issues\fR +Enable issues in the repository + +.TP +\fB--enable-merge-commit\fR +Enable merging pull requests via merge commit + +.TP +\fB--enable-projects\fR +Enable projects in the repository + +.TP +\fB--enable-rebase-merge\fR +Enable merging pull requests via rebase + +.TP +\fB--enable-secret-scanning\fR +Enable secret scanning in the repository + +.TP +\fB--enable-secret-scanning-push-protection\fR +Enable secret scanning push protection in the repository. Secret scanning must be enabled first + +.TP +\fB--enable-squash-merge\fR +Enable merging pull requests via squashed commit + +.TP +\fB--enable-wiki\fR +Enable wiki in the repository + +.TP +\fB-h\fR, \fB--homepage\fR \fB\fR +Repository home page URL + +.TP +\fB--remove-topic\fR \fB\fR +Remove repository topic + +.TP +\fB--template\fR +Make the repository available as a template repository + +.TP +\fB--visibility\fR \fB\fR +Change the visibility of the repository to {public,private,internal} + + +.SH EXIT CODES +0: Successful execution + +.PP +1: Error + +.PP +2: Command canceled + +.PP +4: Authentication required + +.PP +NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information. + + +.SH EXAMPLE +.EX +# Enable issues and wiki +$ gh repo edit --enable-issues --enable-wiki + +# Disable projects +$ gh repo edit --enable-projects=false + +.EE + + +.SH SEE ALSO +\fBgh-repo(1)\fR diff --git a/Main/gh-repo-fork.1 b/Main/gh-repo-fork.1 new file mode 100644 index 0000000..a7d3e9f --- /dev/null +++ b/Main/gh-repo-fork.1 @@ -0,0 +1,74 @@ +.nh +.TH "GH-REPO-FORK" "1" "May 2025" "GitHub CLI 2.73.0" "GitHub CLI manual" + +.SH NAME +gh-repo-fork - Create a fork of a repository + + +.SH SYNOPSIS +\fBgh repo fork [] [-- ...] [flags]\fR + + +.SH DESCRIPTION +Create a fork of a repository. + +.PP +With no argument, creates a fork of the current repository. Otherwise, forks +the specified repository. + +.PP +By default, the new fork is set to be your \fBorigin\fR remote and any existing +origin remote is renamed to \fBupstream\fR\&. To alter this behavior, you can set +a name for the new fork's remote with \fB--remote-name\fR\&. + +.PP +The \fBupstream\fR remote will be set as the default remote repository. + +.PP +Additional \fBgit clone\fR flags can be passed after \fB--\fR\&. + + +.SH OPTIONS +.TP +\fB--clone\fR +Clone the fork + +.TP +\fB--default-branch-only\fR +Only include the default branch in the fork + +.TP +\fB--fork-name\fR \fB\fR +Rename the forked repository + +.TP +\fB--org\fR \fB\fR +Create the fork in an organization + +.TP +\fB--remote\fR +Add a git remote for the fork + +.TP +\fB--remote-name\fR \fB (default "origin")\fR +Specify the name for the new remote + + +.SH EXIT CODES +0: Successful execution + +.PP +1: Error + +.PP +2: Command canceled + +.PP +4: Authentication required + +.PP +NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information. + + +.SH SEE ALSO +\fBgh-repo(1)\fR diff --git a/Main/gh-repo-gitignore-list.1 b/Main/gh-repo-gitignore-list.1 new file mode 100644 index 0000000..cf30a85 --- /dev/null +++ b/Main/gh-repo-gitignore-list.1 @@ -0,0 +1,33 @@ +.nh +.TH "GH-REPO-GITIGNORE-LIST" "1" "May 2025" "GitHub CLI 2.73.0" "GitHub CLI manual" + +.SH NAME +gh-repo-gitignore-list - List available repository gitignore templates + + +.SH SYNOPSIS +\fBgh repo gitignore list [flags]\fR + + +.SH ALIASES +gh repo gitignore ls + + +.SH EXIT CODES +0: Successful execution + +.PP +1: Error + +.PP +2: Command canceled + +.PP +4: Authentication required + +.PP +NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information. + + +.SH SEE ALSO +\fBgh-repo-gitignore(1)\fR diff --git a/Main/gh-repo-gitignore-view.1 b/Main/gh-repo-gitignore-view.1 new file mode 100644 index 0000000..1a2935c --- /dev/null +++ b/Main/gh-repo-gitignore-view.1 @@ -0,0 +1,56 @@ +.nh +.TH "GH-REPO-GITIGNORE-VIEW" "1" "May 2025" "GitHub CLI 2.73.0" "GitHub CLI manual" + +.SH NAME +gh-repo-gitignore-view - View an available repository gitignore template + + +.SH SYNOPSIS +\fBgh repo gitignore view