diff --git a/gh.zip b/gh.zip new file mode 100644 index 00000000..6106db3f Binary files /dev/null and b/gh.zip differ diff --git a/gh_2.76.2_macOS_amd64/LICENSE b/gh_2.76.2_macOS_amd64/LICENSE new file mode 100644 index 00000000..b6a58a95 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2019 GitHub Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/gh_2.76.2_macOS_amd64/bin/gh b/gh_2.76.2_macOS_amd64/bin/gh new file mode 100755 index 00000000..2cdea78e Binary files /dev/null and b/gh_2.76.2_macOS_amd64/bin/gh differ diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-alias-delete.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-alias-delete.1 new file mode 100644 index 00000000..8e02cd78 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-alias-delete.1 @@ -0,0 +1,35 @@ +.nh +.TH "GH-ALIAS-DELETE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-alias-delete - Delete set aliases + + +.SH SYNOPSIS +\fBgh alias delete { | --all} [flags]\fR + + +.SH OPTIONS +.TP +\fB--all\fR +Delete all aliases + + +.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-alias(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-alias-import.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-alias-import.1 new file mode 100644 index 00000000..725d4abf --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-alias-import.1 @@ -0,0 +1,71 @@ +.nh +.TH "GH-ALIAS-IMPORT" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-alias-import - Import aliases from a YAML file + + +.SH SYNOPSIS +\fBgh alias import [ | -] [flags]\fR + + +.SH DESCRIPTION +Import aliases from the contents of a YAML file. + +.PP +Aliases should be defined as a map in YAML, where the keys represent aliases and +the values represent the corresponding expansions. An example file should look like +the following: + +.EX +bugs: issue list --label=bug +igrep: '!gh issue list --label="$1" | grep "$2"' +features: |- + issue list + --label=enhancement +.EE + +.PP +Use \fB-\fR to read aliases (in YAML format) from standard input. + +.PP +The output from \fBgh alias list\fR can be used to produce a YAML file +containing your aliases, which you can use to import them from one machine to +another. Run \fBgh help alias list\fR to learn more. + + +.SH OPTIONS +.TP +\fB--clobber\fR +Overwrite existing aliases of the same name + + +.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 +# Import aliases from a file +$ gh alias import aliases.yml + +# Import aliases from standard input +$ gh alias import - + +.EE + + +.SH SEE ALSO +\fBgh-alias(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-alias-list.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-alias-list.1 new file mode 100644 index 00000000..3dee3131 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-alias-list.1 @@ -0,0 +1,37 @@ +.nh +.TH "GH-ALIAS-LIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-alias-list - List your aliases + + +.SH SYNOPSIS +\fBgh alias list [flags]\fR + + +.SH DESCRIPTION +This command prints out all of the aliases gh is configured to use. + + +.SH ALIASES +gh alias 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-alias(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-alias-set.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-alias-set.1 new file mode 100644 index 00000000..6d686f49 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-alias-set.1 @@ -0,0 +1,82 @@ +.nh +.TH "GH-ALIAS-SET" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-alias-set - Create a shortcut for a gh command + + +.SH SYNOPSIS +\fBgh alias set [flags]\fR + + +.SH DESCRIPTION +Define a word that will expand to a full gh command when invoked. + +.PP +The expansion may specify additional arguments and flags. If the expansion includes +positional placeholders such as \fB$1\fR, extra arguments that follow the alias will be +inserted appropriately. Otherwise, extra arguments will be appended to the expanded +command. + +.PP +Use \fB-\fR as expansion argument to read the expansion string from standard input. This +is useful to avoid quoting issues when defining expansions. + +.PP +If the expansion starts with \fB!\fR or if \fB--shell\fR was given, the expansion is a shell +expression that will be evaluated through the \fBsh\fR interpreter when the alias is +invoked. This allows for chaining multiple commands via piping and redirection. + + +.SH OPTIONS +.TP +\fB--clobber\fR +Overwrite existing aliases of the same name + +.TP +\fB-s\fR, \fB--shell\fR +Declare an alias to be passed through a shell interpreter + + +.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 +# Note: Command Prompt on Windows requires using double quotes for arguments +$ gh alias set pv 'pr view' +$ gh pv -w 123 #=> gh pr view -w 123 + +$ gh alias set bugs 'issue list --label=bugs' +$ gh bugs + +$ gh alias set homework 'issue list --assignee @me' +$ gh homework + +$ gh alias set 'issue mine' 'issue list --mention @me' +$ gh issue mine + +$ gh alias set epicsBy 'issue list --author="$1" --label="epic"' +$ gh epicsBy vilmibm #=> gh issue list --author="vilmibm" --label="epic" + +$ gh alias set --shell igrep 'gh issue list --label="$1" | grep "$2"' +$ gh igrep epic foo #=> gh issue list --label="epic" | grep "foo" + +.EE + + +.SH SEE ALSO +\fBgh-alias(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-alias.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-alias.1 new file mode 100644 index 00000000..92dbeadc --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-alias.1 @@ -0,0 +1,54 @@ +.nh +.TH "GH-ALIAS" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-alias - Create command shortcuts + + +.SH SYNOPSIS +\fBgh alias [flags]\fR + + +.SH DESCRIPTION +Aliases can be used to make shortcuts for gh commands or to compose multiple commands. + +.PP +Run \fBgh help alias set\fR to learn more. + + +.SH AVAILABLE COMMANDS +.TP +\fBgh-alias-delete(1)\fR +Delete set aliases + +.TP +\fBgh-alias-import(1)\fR +Import aliases from a YAML file + +.TP +\fBgh-alias-list(1)\fR +List your aliases + +.TP +\fBgh-alias-set(1)\fR +Create a shortcut for a gh command + + +.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/gh_2.76.2_macOS_amd64/share/man/man1/gh-api.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-api.1 new file mode 100644 index 00000000..001b416e --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-api.1 @@ -0,0 +1,241 @@ +.nh +.TH "GH-API" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-api - Make an authenticated GitHub API request + + +.SH SYNOPSIS +\fBgh api [flags]\fR + + +.SH DESCRIPTION +Makes an authenticated HTTP request to the GitHub API and prints the response. + +.PP +The endpoint argument should either be a path of a GitHub API v3 endpoint, or +\fBgraphql\fR to access the GitHub API v4. + +.PP +Placeholder values \fB{owner}\fR, \fB{repo}\fR, and \fB{branch}\fR in the endpoint +argument will get replaced with values from the repository of the current +directory or the repository specified in the \fBGH_REPO\fR environment variable. +Note that in some shells, for example PowerShell, you may need to enclose +any value that contains \fB{...}\fR in quotes to prevent the shell from +applying special meaning to curly braces. + +.PP +The \fB-p/--preview\fR flag enables opting into previews, which are feature-flagged, +experimental API endpoints or behaviors. The API expects opt-in via the \fBAccept\fR +header with format \fBapplication/vnd.github.-preview+json\fR and this +command facilitates that via \fB--preview \fR\&. To send a request for +the corsair and scarlet witch previews, you could use \fB-p corsair,scarlet-witch\fR +or \fB--preview corsair --preview scarlet-witch\fR\&. + +.PP +The default HTTP request method is \fBGET\fR normally and \fBPOST\fR if any parameters +were added. Override the method with \fB--method\fR\&. + +.PP +Pass one or more \fB-f/--raw-field\fR values in \fBkey=value\fR format to add static string +parameters to the request payload. To add non-string or placeholder-determined values, see +\fB-F/--field\fR below. Note that adding request parameters will automatically switch the +request method to \fBPOST\fR\&. To send the parameters as a \fBGET\fR query string instead, use +\fB--method GET\fR\&. + +.PP +The \fB-F/--field\fR flag has magic type conversion based on the format of the value: +.IP \(bu 2 +literal values \fBtrue\fR, \fBfalse\fR, \fBnull\fR, and integer numbers get converted to +appropriate JSON types; +.IP \(bu 2 +placeholder values \fB{owner}\fR, \fB{repo}\fR, and \fB{branch}\fR get populated with values +from the repository of the current directory; +.IP \(bu 2 +if the value starts with \fB@\fR, the rest of the value is interpreted as a +filename to read the value from. Pass \fB-\fR to read from standard input. + +.PP +For GraphQL requests, all fields other than \fBquery\fR and \fBoperationName\fR are +interpreted as GraphQL variables. + +.PP +To pass nested parameters in the request payload, use \fBkey[subkey]=value\fR syntax when +declaring fields. To pass nested values as arrays, declare multiple fields with the +syntax \fBkey[]=value1\fR, \fBkey[]=value2\fR\&. To pass an empty array, use \fBkey[]\fR without a +value. + +.PP +To pass pre-constructed JSON or payloads in other formats, a request body may be read +from file specified by \fB--input\fR\&. Use \fB-\fR to read from standard input. When passing the +request body this way, any parameters specified via field flags are added to the query +string of the endpoint URL. + +.PP +In \fB--paginate\fR mode, all pages of results will sequentially be requested until +there are no more pages of results. For GraphQL requests, this requires that the +original query accepts an \fB$endCursor: String\fR variable and that it fetches the +\fBpageInfo{ hasNextPage, endCursor }\fR set of fields from a collection. Each page is a separate +JSON array or object. Pass \fB--slurp\fR to wrap all pages of JSON arrays or objects +into an outer JSON array. + + +.SH OPTIONS +.TP +\fB--cache\fR \fB\fR +Cache the response, e.g. "3600s", "60m", "1h" + +.TP +\fB-F\fR, \fB--field\fR \fB\fR +Add a typed parameter in key=value format + +.TP +\fB-H\fR, \fB--header\fR \fB\fR +Add a HTTP request header in key:value format + +.TP +\fB--hostname\fR \fB\fR +The GitHub hostname for the request (default "github.com") + +.TP +\fB-i\fR, \fB--include\fR +Include HTTP response status line and headers in the output + +.TP +\fB--input\fR \fB\fR +The file to use as body for the HTTP request (use "-" to read from standard input) + +.TP +\fB-q\fR, \fB--jq\fR \fB\fR +Query to select values from the response using jq syntax + +.TP +\fB-X\fR, \fB--method\fR \fB (default "GET")\fR +The HTTP method for the request + +.TP +\fB--paginate\fR +Make additional HTTP requests to fetch all pages of results + +.TP +\fB-p\fR, \fB--preview\fR \fB\fR +Opt into GitHub API previews (names should omit '-preview') + +.TP +\fB-f\fR, \fB--raw-field\fR \fB\fR +Add a string parameter in key=value format + +.TP +\fB--silent\fR +Do not print the response body + +.TP +\fB--slurp\fR +Use with "--paginate" to return an array of all pages of either JSON arrays or objects + +.TP +\fB-t\fR, \fB--template\fR \fB\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB--verbose\fR +Include full HTTP request and response in the output + + +.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 +# List releases in the current repository +$ gh api repos/{owner}/{repo}/releases + +# Post an issue comment +$ gh api repos/{owner}/{repo}/issues/123/comments -f body='Hi from CLI' + +# Post nested parameter read from a file +$ gh api gists -F 'files[myfile.txt][content]=@myfile.txt' + +# Add parameters to a GET request +$ gh api -X GET search/issues -f q='repo:cli/cli is:open remote' + +# Set a custom HTTP header +$ gh api -H 'Accept: application/vnd.github.v3.raw+json' ... + +# Opt into GitHub API previews +$ gh api --preview baptiste,nebula ... + +# Print only specific fields from the response +$ gh api repos/{owner}/{repo}/issues --jq '.[].title' + +# Use a template for the output +$ gh api repos/{owner}/{repo}/issues --template \\ + '{{range .}}{{.title}} ({{.labels | pluck "name" | join ", " | color "yellow"}}){{"\\n"}}{{end}}' + +# Update allowed values of the "environment" custom property in a deeply nested array +$ gh api -X PATCH /orgs/{org}/properties/schema \\ + -F 'properties[][property_name]=environment' \\ + -F 'properties[][default_value]=production' \\ + -F 'properties[][allowed_values][]=staging' \\ + -F 'properties[][allowed_values][]=production' + +# List releases with GraphQL +$ gh api graphql -F owner='{owner}' -F name='{repo}' -f query=' + query($name: String!, $owner: String!) { + repository(owner: $owner, name: $name) { + releases(last: 3) { + nodes { tagName } + } + } + } +\&' + +# List all repositories for a user +$ gh api graphql --paginate -f query=' + query($endCursor: String) { + viewer { + repositories(first: 100, after: $endCursor) { + nodes { nameWithOwner } + pageInfo { + hasNextPage + endCursor + } + } + } + } +\&' + +# Get the percentage of forks for the current user +$ gh api graphql --paginate --slurp -f query=' + query($endCursor: String) { + viewer { + repositories(first: 100, after: $endCursor) { + nodes { isFork } + pageInfo { + hasNextPage + endCursor + } + } + } + } +\&' | jq 'def count(e): reduce e as $_ (0;.+1); +[.[].data.viewer.repositories.nodes[]] as $r | count(select($r[].isFork))/count($r[])' + +.EE + + +.SH SEE ALSO +\fBgh(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-attestation-download.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-attestation-download.1 new file mode 100644 index 00000000..d14ccc9f --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-attestation-download.1 @@ -0,0 +1,105 @@ +.nh +.TH "GH-ATTESTATION-DOWNLOAD" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-attestation-download - Download an artifact's attestations for offline use + + +.SH SYNOPSIS +\fBgh attestation download [ | oci://] [--owner | --repo] [flags]\fR + + +.SH DESCRIPTION +.SS NOTE: This feature is currently in public preview, and subject to change. +Download attestations associated with an artifact for offline use. + +.PP +The command requires either: +* a file path to an artifact, or +* a container image URI (e.g. \fBoci://\fR) + * (note that if you provide an OCI URL, you must already be authenticated with +its container registry) + +.PP +In addition, the command requires either: +* the \fB--repo\fR flag (e.g. --repo github/example). +* the \fB--owner\fR flag (e.g. --owner github), or + +.PP +The \fB--repo\fR flag value must match the name of the GitHub repository +that the artifact is linked with. + +.PP +The \fB--owner\fR flag value must match the name of the GitHub organization +that the artifact's linked repository belongs to. + +.PP +Any associated bundle(s) will be written to a file in the +current directory named after the artifact's digest. For example, if the +digest is "sha256:1234", the file will be named "sha256:1234.jsonl". + +.PP +Colons are special characters on Windows and cannot be used in +file names. To accommodate, a dash will be used to separate the algorithm +from the digest in the attestations file name. For example, if the digest +is "sha256:1234", the file will be named "sha256-1234.jsonl". + + +.SH OPTIONS +.TP +\fB-d\fR, \fB--digest-alg\fR \fB (default "sha256")\fR +The algorithm used to compute a digest of the artifact: {sha256|sha512} + +.TP +\fB--hostname\fR \fB\fR +Configure host to use + +.TP +\fB-L\fR, \fB--limit\fR \fB (default 30)\fR +Maximum number of attestations to fetch + +.TP +\fB-o\fR, \fB--owner\fR \fB\fR +GitHub organization to scope attestation lookup by + +.TP +\fB--predicate-type\fR \fB\fR +Filter attestations by provided predicate type + +.TP +\fB-R\fR, \fB--repo\fR \fB\fR +Repository name in the 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 +# Download attestations for a local artifact linked with an organization +$ gh attestation download example.bin -o github + +# Download attestations for a local artifact linked with a repository +$ gh attestation download example.bin -R github/example + +# Download attestations for an OCI image linked with an organization +$ gh attestation download oci://example.com/foo/bar:latest -o github + +.EE + + +.SH SEE ALSO +\fBgh-attestation(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-attestation-trusted-root.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-attestation-trusted-root.1 new file mode 100644 index 00000000..41841be3 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-attestation-trusted-root.1 @@ -0,0 +1,79 @@ +.nh +.TH "GH-ATTESTATION-TRUSTED-ROOT" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-attestation-trusted-root - Output trusted_root.jsonl contents, likely for offline verification + + +.SH SYNOPSIS +\fBgh attestation trusted-root [--tuf-url --tuf-root ] [--verify-only] [flags]\fR + + +.SH DESCRIPTION +.SS NOTE: This feature is currently in public preview, and subject to change. +Output contents for a trusted_root.jsonl file, likely for offline verification. + +.PP +When using \fBgh attestation verify\fR, if your machine is on the internet, +this will happen automatically. But to do offline verification, you need to +supply a trusted root file with \fB--custom-trusted-root\fR; this command +will help you fetch a \fBtrusted_root.jsonl\fR file for that purpose. + +.PP +You can call this command without any flags to get a trusted root file covering +the Sigstore Public Good Instance as well as GitHub's Sigstore instance. + +.PP +Otherwise you can use \fB--tuf-url\fR to specify the URL of a custom TUF +repository mirror, and \fB--tuf-root\fR should be the path to the +\fBroot.json\fR file that you securely obtained out-of-band. + +.PP +If you just want to verify the integrity of your local TUF repository, and don't +want the contents of a trusted_root.jsonl file, use \fB--verify-only\fR\&. + + +.SH OPTIONS +.TP +\fB--hostname\fR \fB\fR +Configure host to use + +.TP +\fB--tuf-root\fR \fB\fR +Path to the TUF root.json file on disk + +.TP +\fB--tuf-url\fR \fB\fR +URL to the TUF repository mirror + +.TP +\fB--verify-only\fR +Don't output trusted_root.jsonl contents + + +.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 +# Get a trusted_root.jsonl for both Sigstore Public Good and GitHub's instance +$ gh attestation trusted-root + +.EE + + +.SH SEE ALSO +\fBgh-attestation(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-attestation-verify.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-attestation-verify.1 new file mode 100644 index 00000000..88fb1745 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-attestation-verify.1 @@ -0,0 +1,263 @@ +.nh +.TH "GH-ATTESTATION-VERIFY" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-attestation-verify - Verify an artifact's integrity using attestations + + +.SH SYNOPSIS +\fBgh attestation verify [ | oci://] [--owner | --repo] [flags]\fR + + +.SH DESCRIPTION +Verify the integrity and provenance of an artifact using its associated +cryptographically signed attestations. + +.SH Understanding Verification +An attestation is a claim (i.e. a provenance statement) made by an actor +(i.e. a GitHub Actions workflow) regarding a subject (i.e. an artifact). + +.PP +In order to verify an attestation, you must provide an artifact and validate: +* the identity of the actor that produced the attestation +* the expected attestation predicate type (the nature of the claim) + +.PP +By default, this command enforces the \fBhttps://slsa.dev/provenance/v1\fR +predicate type. To verify other attestation predicate types use the +\fB--predicate-type\fR flag. + +.PP +The "actor identity" consists of: +* the repository or the repository owner the artifact is linked with +* the Actions workflow that produced the attestation (a.k.a the + signer workflow) + +.PP +This identity is then validated against the attestation's certificate's +SourceRepository, SourceRepositoryOwner, and SubjectAlternativeName +(SAN) fields, among others. + +.PP +It is up to you to decide how precisely you want to enforce this identity. + +.PP +At a minimum, this command requires either: +* the \fB--owner\fR flag (e.g. --owner github), or +* the \fB--repo\fR flag (e.g. --repo github/example) + +.PP +The more precisely you specify the identity, the more control you will +have over the security guarantees offered by the verification process. + +.PP +Ideally, the path of the signer workflow is also validated using the +\fB--signer-workflow\fR or \fB--cert-identity\fR flags. + +.PP +Please note: if your attestation was generated via a reusable workflow then +that reusable workflow is the signer whose identity needs to be validated. +In this situation, you must use either the \fB--signer-workflow\fR or +the \fB--signer-repo\fR flag. + +.PP +For more options, see the other available flags. + +.SH Loading Artifacts And Attestations +To specify the artifact, this command requires: +* a file path to an artifact, or +* a container image URI (e.g. \fBoci://\fR) + * (note that if you provide an OCI URL, you must already be authenticated with +its container registry) + +.PP +By default, this command will attempt to fetch relevant attestations via the +GitHub API using the values provided to \fB--owner\fR or \fB--repo\fR\&. + +.PP +To instead fetch attestations from your artifact's OCI registry, use the +\fB--bundle-from-oci\fR flag. + +.PP +For offline verification using attestations stored on disk (c.f. the download command) +provide a path to the \fB--bundle\fR flag. + +.SH Additional Policy Enforcement +Given the \fB--format=json\fR flag, upon successful verification this +command will output a JSON array containing one entry per verified attestation. + +.PP +This output can then be used for additional policy enforcement, i.e. by being +piped into a policy engine. + +.PP +Each object in the array contains two properties: +* an \fBattestation\fR object, which contains the bundle that was verified +* a \fBverificationResult\fR object, which is a parsed representation of the + contents of the bundle that was verified. + +.PP +Within the \fBverificationResult\fR object you will find: +* \fBsignature.certificate\fR, which is a parsed representation of the X.509 + certificate embedded in the attestation, +* \fBverifiedTimestamps\fR, an array of objects denoting when the attestation + was witnessed by a transparency log or a timestamp authority +* \fBstatement\fR, which contains the \fBsubject\fR array referencing artifacts, + the \fBpredicateType\fR field, and the \fBpredicate\fR object which contains + additional, often user-controllable, metadata + +.PP +IMPORTANT: please note that only the \fBsignature.certificate\fR and the +\fBverifiedTimestamps\fR properties contain values that cannot be +manipulated by the workflow that originated the attestation. + +.PP +When dealing with attestations created within GitHub Actions, the contents of +\fBsignature.certificate\fR are populated directly from the OpenID Connect +token that GitHub has generated. The contents of the \fBverifiedTimestamps\fR +array are populated from the signed timestamps originating from either a +transparency log or a timestamp authority – and likewise cannot be forged by users. + +.PP +When designing policy enforcement using this output, special care must be taken +when examining the contents of the \fBstatement.predicate\fR property: +should an attacker gain access to your workflow's execution context, they +could then falsify the contents of the \fBstatement.predicate\fR\&. + +.PP +To mitigate this attack vector, consider using a "trusted builder": when generating +an artifact, have the build and attestation signing occur within a reusable workflow +whose execution cannot be influenced by input provided through the caller workflow. + +.PP +See above re: \fB--signer-workflow\fR\&. + + +.SH OPTIONS +.TP +\fB-b\fR, \fB--bundle\fR \fB\fR +Path to bundle on disk, either a single bundle in a JSON file or a JSON lines file with multiple bundles + +.TP +\fB--bundle-from-oci\fR +When verifying an OCI image, fetch the attestation bundle from the OCI registry instead of from GitHub + +.TP +\fB--cert-identity\fR \fB\fR +Enforce that the certificate's SubjectAlternativeName matches the provided value exactly + +.TP +\fB-i\fR, \fB--cert-identity-regex\fR \fB\fR +Enforce that the certificate's SubjectAlternativeName matches the provided regex + +.TP +\fB--cert-oidc-issuer\fR \fB (default "https://token.actions.githubusercontent.com")\fR +Enforce that the issuer of the OIDC token matches the provided value + +.TP +\fB--custom-trusted-root\fR \fB\fR +Path to a trusted_root.jsonl file; likely for offline verification + +.TP +\fB--deny-self-hosted-runners\fR +Fail verification for attestations generated on self-hosted runners + +.TP +\fB-d\fR, \fB--digest-alg\fR \fB (default "sha256")\fR +The algorithm used to compute a digest of the artifact: {sha256|sha512} + +.TP +\fB--format\fR \fB\fR +Output format: {json} + +.TP +\fB--hostname\fR \fB\fR +Configure host to use + +.TP +\fB-q\fR, \fB--jq\fR \fB\fR +Filter JSON output using a jq expression + +.TP +\fB-L\fR, \fB--limit\fR \fB (default 30)\fR +Maximum number of attestations to fetch + +.TP +\fB--no-public-good\fR +Do not verify attestations signed with Sigstore public good instance + +.TP +\fB-o\fR, \fB--owner\fR \fB\fR +GitHub organization to scope attestation lookup by + +.TP +\fB--predicate-type\fR \fB (default "https://slsa.dev/provenance/v1")\fR +Enforce that verified attestations' predicate type matches the provided value + +.TP +\fB-R\fR, \fB--repo\fR \fB\fR +Repository name in the format / + +.TP +\fB--signer-digest\fR \fB\fR +Enforce that the digest associated with the signer workflow matches the provided value + +.TP +\fB--signer-repo\fR \fB\fR +Enforce that the workflow that signed the attestation's repository matches the provided value (/) + +.TP +\fB--signer-workflow\fR \fB\fR +Enforce that the workflow that signed the attestation matches the provided value ([host/]////) + +.TP +\fB--source-digest\fR \fB\fR +Enforce that the digest associated with the source repository matches the provided value + +.TP +\fB--source-ref\fR \fB\fR +Enforce that the git ref associated with the source repository matches the provided value + +.TP +\fB-t\fR, \fB--template\fR \fB\fR +Format JSON output using a Go template; see "gh help formatting" + + +.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 +# Verify an artifact linked with a repository +$ gh attestation verify example.bin --repo github/example + +# Verify an artifact linked with an organization +$ gh attestation verify example.bin --owner github + +# Verify an artifact and output the full verification result +$ gh attestation verify example.bin --owner github --format json + +# Verify an OCI image using attestations stored on disk +$ gh attestation verify oci:// --owner github --bundle sha256:foo.jsonl + +# Verify an artifact signed with a reusable workflow +$ gh attestation verify example.bin --owner github --signer-repo actions/example + +.EE + + +.SH SEE ALSO +\fBgh-attestation(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-attestation.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-attestation.1 new file mode 100644 index 00000000..a162c976 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-attestation.1 @@ -0,0 +1,51 @@ +.nh +.TH "GH-ATTESTATION" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-attestation - Work with artifact attestations + + +.SH SYNOPSIS +\fBgh attestation [subcommand] [flags]\fR + + +.SH DESCRIPTION +Download and verify artifact attestations. + + +.SH AVAILABLE COMMANDS +.TP +\fBgh-attestation-download(1)\fR +Download an artifact's attestations for offline use + +.TP +\fBgh-attestation-trusted-root(1)\fR +Output trusted_root.jsonl contents, likely for offline verification + +.TP +\fBgh-attestation-verify(1)\fR +Verify an artifact's integrity using attestations + + +.SH ALIASES +gh at + + +.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/gh_2.76.2_macOS_amd64/share/man/man1/gh-auth-login.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-auth-login.1 new file mode 100644 index 00000000..b76eb9d1 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-auth-login.1 @@ -0,0 +1,118 @@ +.nh +.TH "GH-AUTH-LOGIN" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-auth-login - Log in to a GitHub account + + +.SH SYNOPSIS +\fBgh auth login [flags]\fR + + +.SH DESCRIPTION +Authenticate with a GitHub host. + +.PP +The default hostname is \fBgithub.com\fR\&. This can be overridden using the \fB--hostname\fR +flag. + +.PP +The default authentication mode is a web-based browser flow. After completion, an +authentication token will be stored securely in the system credential store. +If a credential store is not found or there is an issue using it gh will fallback +to writing the token to a plain text file. See \fBgh auth status\fR for its +stored location. + +.PP +Alternatively, use \fB--with-token\fR to pass in a personal access token (classic) on standard input. +The minimum required scopes for the token are: \fBrepo\fR, \fBread:org\fR, and \fBgist\fR\&. +Take care when passing a fine-grained personal access token to \fB--with-token\fR +as the inherent scoping to certain resources may cause confusing behaviour when interacting with other +resources. Favour setting \fBGH_TOKEN\fR for fine-grained personal access token usage. + +.PP +Alternatively, gh will use the authentication token found in environment variables. +This method is most suitable for "headless" use of gh such as in automation. See +\fBgh help environment\fR for more info. + +.PP +To use gh in GitHub Actions, add \fBGH_TOKEN: ${{ github.token }}\fR to \fBenv\fR\&. + +.PP +The git protocol to use for git operations on this host can be set with \fB--git-protocol\fR, +or during the interactive prompting. Although login is for a single account on a host, setting +the git protocol will take effect for all users on the host. + +.PP +Specifying \fBssh\fR for the git protocol will detect existing SSH keys to upload, +prompting to create and upload a new key if one is not found. This can be skipped with +\fB--skip-ssh-key\fR flag. + +.PP +For more information on OAuth scopes, see + +\[la]https://docs.github.com/en/developers/apps/building\-oauth\-apps/scopes\-for\-oauth\-apps/\[ra]\&. + + +.SH OPTIONS +.TP +\fB-p\fR, \fB--git-protocol\fR \fB\fR +The protocol to use for git operations on this host: {ssh|https} + +.TP +\fB-h\fR, \fB--hostname\fR \fB\fR +The hostname of the GitHub instance to authenticate with + +.TP +\fB--insecure-storage\fR +Save authentication credentials in plain text instead of credential store + +.TP +\fB-s\fR, \fB--scopes\fR \fB\fR +Additional authentication scopes to request + +.TP +\fB--skip-ssh-key\fR +Skip generate/upload SSH key prompt + +.TP +\fB-w\fR, \fB--web\fR +Open a browser to authenticate + +.TP +\fB--with-token\fR +Read token from standard input + + +.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 +# Start interactive setup +$ gh auth login + +# Authenticate against github.com by reading the token from a file +$ gh auth login --with-token < mytoken.txt + +# Authenticate with specific host +$ gh auth login --hostname enterprise.internal + +.EE + + +.SH SEE ALSO +\fBgh-auth(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-auth-logout.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-auth-logout.1 new file mode 100644 index 00000000..544980a1 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-auth-logout.1 @@ -0,0 +1,83 @@ +.nh +.TH "GH-AUTH-LOGOUT" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-auth-logout - Log out of a GitHub account + + +.SH SYNOPSIS +\fBgh auth logout [flags]\fR + + +.SH DESCRIPTION +Remove authentication for a GitHub account. + +.PP +This command removes the stored authentication configuration +for an account. The authentication configuration is only +removed locally. + +.PP +This command does not revoke authentication tokens. + +.PP +To revoke all authentication tokens generated by the GitHub CLI: +.IP " 1." 5 +Visit +\[la]https://github.com/settings/applications\[ra] +.IP " 2." 5 +Select the "GitHub CLI" application +.IP " 3." 5 +Select "Revoke Access" +.IP " 4." 5 +Select "I understand, revoke access" + +.PP +Note: this procedure will revoke all authentication tokens ever +generated by the GitHub CLI across all your devices. + +.PP +For more information about revoking OAuth application tokens, see: + +\[la]https://docs.github.com/en/apps/oauth\-apps/using\-oauth\-apps/reviewing\-your\-authorized\-oauth\-apps\[ra] + + +.SH OPTIONS +.TP +\fB-h\fR, \fB--hostname\fR \fB\fR +The hostname of the GitHub instance to log out of + +.TP +\fB-u\fR, \fB--user\fR \fB\fR +The account to log out of + + +.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 +# Select what host and account to log out of via a prompt +$ gh auth logout + +# Log out of a specific host and specific account +$ gh auth logout --hostname enterprise.internal --user monalisa + +.EE + + +.SH SEE ALSO +\fBgh-auth(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-auth-refresh.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-auth-refresh.1 new file mode 100644 index 00000000..b169855b --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-auth-refresh.1 @@ -0,0 +1,96 @@ +.nh +.TH "GH-AUTH-REFRESH" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-auth-refresh - Refresh stored authentication credentials + + +.SH SYNOPSIS +\fBgh auth refresh [flags]\fR + + +.SH DESCRIPTION +Expand or fix the permission scopes for stored credentials for active account. + +.PP +The \fB--scopes\fR flag accepts a comma separated list of scopes you want +your gh credentials to have. If no scopes are provided, the command +maintains previously added scopes. + +.PP +The \fB--remove-scopes\fR flag accepts a comma separated list of scopes you +want to remove from your gh credentials. Scope removal is idempotent. +The minimum set of scopes (\fBrepo\fR, \fBread:org\fR, and \fBgist\fR) cannot be removed. + +.PP +The \fB--reset-scopes\fR flag resets the scopes for your gh credentials to +the default set of scopes for your auth flow. + +.PP +If you have multiple accounts in \fBgh auth status\fR and want to refresh the credentials for an +inactive account, you will have to use \fBgh auth switch\fR to that account first before using +this command, and then switch back when you are done. + +.PP +For more information on OAuth scopes, see + +\[la]https://docs.github.com/en/developers/apps/building\-oauth\-apps/scopes\-for\-oauth\-apps/\[ra]\&. + + +.SH OPTIONS +.TP +\fB-h\fR, \fB--hostname\fR \fB\fR +The GitHub host to use for authentication + +.TP +\fB--insecure-storage\fR +Save authentication credentials in plain text instead of credential store + +.TP +\fB-r\fR, \fB--remove-scopes\fR \fB\fR +Authentication scopes to remove from gh + +.TP +\fB--reset-scopes\fR +Reset authentication scopes to the default minimum set of scopes + +.TP +\fB-s\fR, \fB--scopes\fR \fB\fR +Additional authentication scopes for gh to have + + +.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 +# Open a browser to add write:org and read:public_key scopes +$ gh auth refresh --scopes write:org,read:public_key + +# Open a browser to ensure your authentication credentials have the correct minimum scopes +$ gh auth refresh + +# Open a browser to idempotently remove the delete_repo scope +$ gh auth refresh --remove-scopes delete_repo + +# Open a browser to re-authenticate with the default minimum scopes +$ gh auth refresh --reset-scopes + +.EE + + +.SH SEE ALSO +\fBgh-auth(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-auth-setup-git.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-auth-setup-git.1 new file mode 100644 index 00000000..20d9fb82 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-auth-setup-git.1 @@ -0,0 +1,65 @@ +.nh +.TH "GH-AUTH-SETUP-GIT" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-auth-setup-git - Setup git with GitHub CLI + + +.SH SYNOPSIS +\fBgh auth setup-git [flags]\fR + + +.SH DESCRIPTION +This command configures \fBgit\fR to use GitHub CLI as a credential helper. +For more information on git credential helpers please reference: + +\[la]https://git\-scm.com/docs/gitcredentials\[ra]\&. + +.PP +By default, GitHub CLI will be set as the credential helper for all authenticated hosts. +If there is no authenticated hosts the command fails with an error. + +.PP +Alternatively, use the \fB--hostname\fR flag to specify a single host to be configured. +If the host is not authenticated with, the command fails with an error. + + +.SH OPTIONS +.TP +\fB-f\fR, \fB--force\fR \fB<--hostname>\fR +Force setup even if the host is not known. Must be used in conjunction with --hostname + +.TP +\fB-h\fR, \fB--hostname\fR \fB\fR +The hostname to configure git for + + +.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 +# Configure git to use GitHub CLI as the credential helper for all authenticated hosts +$ gh auth setup-git + +# Configure git to use GitHub CLI as the credential helper for enterprise.internal host +$ gh auth setup-git --hostname enterprise.internal + +.EE + + +.SH SEE ALSO +\fBgh-auth(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-auth-status.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-auth-status.1 new file mode 100644 index 00000000..eeb12ba8 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-auth-status.1 @@ -0,0 +1,56 @@ +.nh +.TH "GH-AUTH-STATUS" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-auth-status - Display active account and authentication state on each known GitHub host + + +.SH SYNOPSIS +\fBgh auth status [flags]\fR + + +.SH DESCRIPTION +Display active account and authentication state on each known GitHub host. + +.PP +For each host, the authentication state of each known account is tested and any issues are included in the output. +Each host section will indicate the active account, which will be used when targeting that host. +If an account on any host (or only the one given via \fB--hostname\fR) has authentication issues, +the command will exit with 1 and output to stderr. + +.PP +To change the active account for a host, see \fBgh auth switch\fR\&. + + +.SH OPTIONS +.TP +\fB-a\fR, \fB--active\fR +Display the active account only + +.TP +\fB-h\fR, \fB--hostname\fR \fB\fR +Check only a specific hostname's auth status + +.TP +\fB-t\fR, \fB--show-token\fR +Display the auth token + + +.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-auth(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-auth-switch.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-auth-switch.1 new file mode 100644 index 00000000..1fb179da --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-auth-switch.1 @@ -0,0 +1,66 @@ +.nh +.TH "GH-AUTH-SWITCH" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-auth-switch - Switch active GitHub account + + +.SH SYNOPSIS +\fBgh auth switch [flags]\fR + + +.SH DESCRIPTION +Switch the active account for a GitHub host. + +.PP +This command changes the authentication configuration that will +be used when running commands targeting the specified GitHub host. + +.PP +If the specified host has two accounts, the active account will be switched +automatically. If there are more than two accounts, disambiguation will be +required either through the \fB--user\fR flag or an interactive prompt. + +.PP +For a list of authenticated accounts you can run \fBgh auth status\fR\&. + + +.SH OPTIONS +.TP +\fB-h\fR, \fB--hostname\fR \fB\fR +The hostname of the GitHub instance to switch account for + +.TP +\fB-u\fR, \fB--user\fR \fB\fR +The account to switch to + + +.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 +# Select what host and account to switch to via a prompt +$ gh auth switch + +# Switch the active account on a specific host to a specific user +$ gh auth switch --hostname enterprise.internal --user monalisa + +.EE + + +.SH SEE ALSO +\fBgh-auth(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-auth-token.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-auth-token.1 new file mode 100644 index 00000000..1c69d217 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-auth-token.1 @@ -0,0 +1,49 @@ +.nh +.TH "GH-AUTH-TOKEN" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-auth-token - Print the authentication token gh uses for a hostname and account + + +.SH SYNOPSIS +\fBgh auth token [flags]\fR + + +.SH DESCRIPTION +This command outputs the authentication token for an account on a given GitHub host. + +.PP +Without the \fB--hostname\fR flag, the default host is chosen. + +.PP +Without the \fB--user\fR flag, the active account for the host is chosen. + + +.SH OPTIONS +.TP +\fB-h\fR, \fB--hostname\fR \fB\fR +The hostname of the GitHub instance authenticated with + +.TP +\fB-u\fR, \fB--user\fR \fB\fR +The account to output the token for + + +.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-auth(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-auth.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-auth.1 new file mode 100644 index 00000000..c03ad6c0 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-auth.1 @@ -0,0 +1,59 @@ +.nh +.TH "GH-AUTH" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-auth - Authenticate gh and git with GitHub + + +.SH SYNOPSIS +\fBgh auth [flags]\fR + + +.SH AVAILABLE COMMANDS +.TP +\fBgh-auth-login(1)\fR +Log in to a GitHub account + +.TP +\fBgh-auth-logout(1)\fR +Log out of a GitHub account + +.TP +\fBgh-auth-refresh(1)\fR +Refresh stored authentication credentials + +.TP +\fBgh-auth-setup-git(1)\fR +Setup git with GitHub CLI + +.TP +\fBgh-auth-status(1)\fR +Display active account and authentication state on each known GitHub host + +.TP +\fBgh-auth-switch(1)\fR +Switch active GitHub account + +.TP +\fBgh-auth-token(1)\fR +Print the authentication token gh uses for a hostname and account + + +.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/gh_2.76.2_macOS_amd64/share/man/man1/gh-browse.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-browse.1 new file mode 100644 index 00000000..7befa817 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-browse.1 @@ -0,0 +1,106 @@ +.nh +.TH "GH-BROWSE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-browse - Open repositories, issues, pull requests, and more in the browser + + +.SH SYNOPSIS +\fBgh browse [ | | ] [flags]\fR + + +.SH DESCRIPTION +Transition from the terminal to the web browser to view and interact with: +.IP \(bu 2 +Issues +.IP \(bu 2 +Pull requests +.IP \(bu 2 +Repository content +.IP \(bu 2 +Repository home page +.IP \(bu 2 +Repository settings + + +.SH OPTIONS +.TP +\fB-b\fR, \fB--branch\fR \fB\fR +Select another branch by passing in the branch name + +.TP +\fB-c\fR, \fB--commit\fR \fB\fR +Select another commit by passing in the commit SHA, default is the last commit + +.TP +\fB-n\fR, \fB--no-browser\fR +Print destination URL instead of opening the browser + +.TP +\fB-p\fR, \fB--projects\fR +Open repository projects + +.TP +\fB-r\fR, \fB--releases\fR +Open repository releases + +.TP +\fB-R\fR, \fB--repo\fR \fB<[HOST/]OWNER/REPO>\fR +Select another repository using the [HOST/]OWNER/REPO format + +.TP +\fB-s\fR, \fB--settings\fR +Open repository settings + +.TP +\fB-w\fR, \fB--wiki\fR +Open repository wiki + + +.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 +# Open the home page of the current repository +$ gh browse + +# Open the script directory of the current repository +$ gh browse script/ + +# Open issue or pull request 217 +$ gh browse 217 + +# Open commit page +$ gh browse 77507cd94ccafcf568f8560cfecde965fcfa63 + +# Open repository settings +$ gh browse --settings + +# Open main.go at line 312 +$ gh browse main.go:312 + +# Open main.go with the repository at head of bug-fix branch +$ gh browse main.go --branch bug-fix + +# Open main.go with the repository at commit 775007cd +$ gh browse main.go --commit=77507cd94ccafcf568f8560cfecde965fcfa63 + +.EE + + +.SH SEE ALSO +\fBgh(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-cache-delete.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-cache-delete.1 new file mode 100644 index 00000000..9e3f27cc --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-cache-delete.1 @@ -0,0 +1,72 @@ +.nh +.TH "GH-CACHE-DELETE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-cache-delete - Delete GitHub Actions caches + + +.SH SYNOPSIS +\fBgh cache delete [ | | --all] [flags]\fR + + +.SH DESCRIPTION +Delete GitHub Actions caches. + +.PP +Deletion requires authorization with the \fBrepo\fR scope. + + +.SH OPTIONS +.TP +\fB-a\fR, \fB--all\fR +Delete all caches + +.TP +\fB--succeed-on-no-caches\fR \fB<--all>\fR +Return exit code 0 if no caches found. Must be used in conjunction with --all + + +.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 +# Delete a cache by id +$ gh cache delete 1234 + +# Delete a cache by key +$ gh cache delete cache-key + +# Delete a cache by id in a specific repo +$ gh cache delete 1234 --repo cli/cli + +# Delete all caches (exit code 1 on no caches) +$ gh cache delete --all + +# Delete all caches (exit code 0 on no caches) +$ gh cache delete --all --succeed-on-no-caches + +.EE + + +.SH SEE ALSO +\fBgh-cache(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-cache-list.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-cache-list.1 new file mode 100644 index 00000000..6b678b15 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-cache-list.1 @@ -0,0 +1,100 @@ +.nh +.TH "GH-CACHE-LIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-cache-list - List GitHub Actions caches + + +.SH SYNOPSIS +\fBgh cache 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-k\fR, \fB--key\fR \fB\fR +Filter by cache key prefix + +.TP +\fB-L\fR, \fB--limit\fR \fB (default 30)\fR +Maximum number of caches to fetch + +.TP +\fB-O\fR, \fB--order\fR \fB (default "desc")\fR +Order of caches returned: {asc|desc} + +.TP +\fB-r\fR, \fB--ref\fR \fB\fR +Filter by ref, formatted as refs/heads/ or refs/pull//merge + +.TP +\fB-S\fR, \fB--sort\fR \fB (default "last_accessed_at")\fR +Sort fetched caches: {created_at|last_accessed_at|size_in_bytes} + +.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 cache ls + + +.SH JSON FIELDS +\fBcreatedAt\fR, \fBid\fR, \fBkey\fR, \fBlastAccessedAt\fR, \fBref\fR, \fBsizeInBytes\fR, \fBversion\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 EXAMPLE +.EX +# List caches for current repository +$ gh cache list + +# List caches for specific repository +$ gh cache list --repo cli/cli + +# List caches sorted by least recently accessed +$ gh cache list --sort last_accessed_at --order asc + +# List caches that have keys matching a prefix (or that match exactly) +$ gh cache list --key key-prefix + +# List caches for a specific branch, replace with the actual branch name +$ gh cache list --ref refs/heads/ + +# List caches for a specific pull request, replace with the actual pull request number +$ gh cache list --ref refs/pull//merge + +.EE + + +.SH SEE ALSO +\fBgh-cache(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-cache.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-cache.1 new file mode 100644 index 00000000..42e5bbbc --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-cache.1 @@ -0,0 +1,57 @@ +.nh +.TH "GH-CACHE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-cache - Manage GitHub Actions caches + + +.SH SYNOPSIS +\fBgh cache [flags]\fR + + +.SH DESCRIPTION +Work with GitHub Actions caches. + + +.SH AVAILABLE COMMANDS +.TP +\fBgh-cache-delete(1)\fR +Delete GitHub Actions caches + +.TP +\fBgh-cache-list(1)\fR +List GitHub Actions caches + + +.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 EXAMPLE +.EX +$ gh cache list +$ gh cache delete --all + +.EE + + +.SH SEE ALSO +\fBgh(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-code.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-code.1 new file mode 100644 index 00000000..edf2dcab --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-code.1 @@ -0,0 +1,51 @@ +.nh +.TH "GH-CODESPACE-CODE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-codespace-code - Open a codespace in Visual Studio Code + + +.SH SYNOPSIS +\fBgh codespace code [flags]\fR + + +.SH OPTIONS +.TP +\fB-c\fR, \fB--codespace\fR \fB\fR +Name of the codespace + +.TP +\fB--insiders\fR +Use the insiders version of Visual Studio Code + +.TP +\fB-R\fR, \fB--repo\fR \fB\fR +Filter codespace selection by repository name (user/repo) + +.TP +\fB--repo-owner\fR \fB\fR +Filter codespace selection by repository owner (username or org) + +.TP +\fB-w\fR, \fB--web\fR +Use the web version of Visual Studio Code + + +.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-codespace(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-cp.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-cp.1 new file mode 100644 index 00000000..f995f67c --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-cp.1 @@ -0,0 +1,94 @@ +.nh +.TH "GH-CODESPACE-CP" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-codespace-cp - Copy files between local and remote file systems + + +.SH SYNOPSIS +\fBgh codespace cp [-e] [-r] [-- [...]] ... \fR + + +.SH DESCRIPTION +The \fBcp\fR command copies files between the local and remote file systems. + +.PP +As with the UNIX \fBcp\fR command, the first argument specifies the source and the last +specifies the destination; additional sources may be specified after the first, +if the destination is a directory. + +.PP +The \fB--recursive\fR flag is required if any source is a directory. + +.PP +A \fBremote:\fR prefix on any file name argument indicates that it refers to +the file system of the remote (Codespace) machine. It is resolved relative +to the home directory of the remote user. + +.PP +By default, remote file names are interpreted literally. With the \fB--expand\fR flag, +each such argument is treated in the manner of \fBscp\fR, as a Bash expression to +be evaluated on the remote machine, subject to expansion of tildes, braces, globs, +environment variables, and backticks. For security, do not use this flag with arguments +provided by untrusted users; see +\[la]https://lwn.net/Articles/835962/\[ra] for discussion. + +.PP +By default, the \fBcp\fR command will create a public/private ssh key pair to authenticate with +the codespace inside the \fB~/.ssh directory\fR\&. + + +.SH OPTIONS +.TP +\fB-c\fR, \fB--codespace\fR \fB\fR +Name of the codespace + +.TP +\fB-e\fR, \fB--expand\fR +Expand remote file names on remote shell + +.TP +\fB-p\fR, \fB--profile\fR \fB\fR +Name of the SSH profile to use + +.TP +\fB-r\fR, \fB--recursive\fR +Recursively copy directories + +.TP +\fB-R\fR, \fB--repo\fR \fB\fR +Filter codespace selection by repository name (user/repo) + +.TP +\fB--repo-owner\fR \fB\fR +Filter codespace selection by repository owner (username or org) + + +.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 +$ gh codespace cp -e README.md 'remote:/workspaces/$RepositoryName/' +$ gh codespace cp -e 'remote:~/*.go' ./gofiles/ +$ gh codespace cp -e 'remote:/workspaces/myproj/go.{mod,sum}' ./gofiles/ +$ gh codespace cp -e -- -F ~/.ssh/codespaces_config 'remote:~/*.go' ./gofiles/ + +.EE + + +.SH SEE ALSO +\fBgh-codespace(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-create.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-create.1 new file mode 100644 index 00000000..2f696dad --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-create.1 @@ -0,0 +1,75 @@ +.nh +.TH "GH-CODESPACE-CREATE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-codespace-create - Create a codespace + + +.SH SYNOPSIS +\fBgh codespace create [flags]\fR + + +.SH OPTIONS +.TP +\fB-b\fR, \fB--branch\fR \fB\fR +Repository branch + +.TP +\fB--default-permissions\fR +Do not prompt to accept additional permissions requested by the codespace + +.TP +\fB--devcontainer-path\fR \fB\fR +Path to the devcontainer.json file to use when creating codespace + +.TP +\fB-d\fR, \fB--display-name\fR \fB\fR +Display name for the codespace (48 characters or less) + +.TP +\fB--idle-timeout\fR \fB\fR +Allowed inactivity before codespace is stopped, e.g. "10m", "1h" + +.TP +\fB-l\fR, \fB--location\fR \fB\fR +Location: {EastUs|SouthEastAsia|WestEurope|WestUs2} (determined automatically if not provided) + +.TP +\fB-m\fR, \fB--machine\fR \fB\fR +Hardware specifications for the VM + +.TP +\fB-R\fR, \fB--repo\fR \fB\fR +Repository name with owner: user/repo + +.TP +\fB--retention-period\fR \fB\fR +Allowed time after shutting down before the codespace is automatically deleted (maximum 30 days), e.g. "1h", "72h" + +.TP +\fB-s\fR, \fB--status\fR +Show status of post-create command and dotfiles + +.TP +\fB-w\fR, \fB--web\fR +Create codespace from browser, cannot be used with --display-name, --idle-timeout, or --retention-period + + +.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-codespace(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-delete.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-delete.1 new file mode 100644 index 00000000..794ab772 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-delete.1 @@ -0,0 +1,74 @@ +.nh +.TH "GH-CODESPACE-DELETE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-codespace-delete - Delete codespaces + + +.SH SYNOPSIS +\fBgh codespace delete [flags]\fR + + +.SH DESCRIPTION +Delete codespaces based on selection criteria. + +.PP +All codespaces for the authenticated user can be deleted, as well as codespaces for a +specific repository. Alternatively, only codespaces older than N days can be deleted. + +.PP +Organization administrators may delete any codespace billed to the organization. + + +.SH OPTIONS +.TP +\fB--all\fR +Delete all codespaces + +.TP +\fB-c\fR, \fB--codespace\fR \fB\fR +Name of the codespace + +.TP +\fB--days\fR \fB (default 0)\fR +Delete codespaces older than N days + +.TP +\fB-f\fR, \fB--force\fR +Skip confirmation for codespaces that contain unsaved changes + +.TP +\fB-o\fR, \fB--org\fR \fB\fR +The login handle of the organization (admin-only) + +.TP +\fB-R\fR, \fB--repo\fR \fB\fR +Filter codespace selection by repository name (user/repo) + +.TP +\fB--repo-owner\fR \fB\fR +Filter codespace selection by repository owner (username or org) + +.TP +\fB-u\fR, \fB--user\fR \fB\fR +The username to delete codespaces for (used with --org) + + +.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-codespace(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-edit.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-edit.1 new file mode 100644 index 00000000..3a5e2d3a --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-edit.1 @@ -0,0 +1,51 @@ +.nh +.TH "GH-CODESPACE-EDIT" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-codespace-edit - Edit a codespace + + +.SH SYNOPSIS +\fBgh codespace edit [flags]\fR + + +.SH OPTIONS +.TP +\fB-c\fR, \fB--codespace\fR \fB\fR +Name of the codespace + +.TP +\fB-d\fR, \fB--display-name\fR \fB\fR +Set the display name + +.TP +\fB-m\fR, \fB--machine\fR \fB\fR +Set hardware specifications for the VM + +.TP +\fB-R\fR, \fB--repo\fR \fB\fR +Filter codespace selection by repository name (user/repo) + +.TP +\fB--repo-owner\fR \fB\fR +Filter codespace selection by repository owner (username or org) + + +.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-codespace(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-jupyter.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-jupyter.1 new file mode 100644 index 00000000..9b85ccff --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-jupyter.1 @@ -0,0 +1,43 @@ +.nh +.TH "GH-CODESPACE-JUPYTER" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-codespace-jupyter - Open a codespace in JupyterLab + + +.SH SYNOPSIS +\fBgh codespace jupyter [flags]\fR + + +.SH OPTIONS +.TP +\fB-c\fR, \fB--codespace\fR \fB\fR +Name of the codespace + +.TP +\fB-R\fR, \fB--repo\fR \fB\fR +Filter codespace selection by repository name (user/repo) + +.TP +\fB--repo-owner\fR \fB\fR +Filter codespace selection by repository owner (username or org) + + +.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-codespace(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-list.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-list.1 new file mode 100644 index 00000000..0eb86388 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-list.1 @@ -0,0 +1,78 @@ +.nh +.TH "GH-CODESPACE-LIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-codespace-list - List codespaces + + +.SH SYNOPSIS +\fBgh codespace list [flags]\fR + + +.SH DESCRIPTION +List codespaces of the authenticated user. + +.PP +Alternatively, organization administrators may list all codespaces billed to the organization. + + +.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-L\fR, \fB--limit\fR \fB (default 30)\fR +Maximum number of codespaces to list + +.TP +\fB-o\fR, \fB--org\fR \fB\fR +The login handle of the organization to list codespaces for (admin-only) + +.TP +\fB-R\fR, \fB--repo\fR \fB\fR +Repository name with owner: user/repo + +.TP +\fB-t\fR, \fB--template\fR \fB\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB-u\fR, \fB--user\fR \fB\fR +The username to list codespaces for (used with --org) + +.TP +\fB-w\fR, \fB--web\fR +List codespaces in the web browser, cannot be used with --user or --org + + +.SH ALIASES +gh codespace ls, gh cs ls + + +.SH JSON FIELDS +\fBcreatedAt\fR, \fBdisplayName\fR, \fBgitStatus\fR, \fBlastUsedAt\fR, \fBmachineName\fR, \fBname\fR, \fBowner\fR, \fBrepository\fR, \fBstate\fR, \fBvscsTarget\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-codespace(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-logs.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-logs.1 new file mode 100644 index 00000000..8509d515 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-logs.1 @@ -0,0 +1,47 @@ +.nh +.TH "GH-CODESPACE-LOGS" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-codespace-logs - Access codespace logs + + +.SH SYNOPSIS +\fBgh codespace logs [flags]\fR + + +.SH OPTIONS +.TP +\fB-c\fR, \fB--codespace\fR \fB\fR +Name of the codespace + +.TP +\fB-f\fR, \fB--follow\fR +Tail and follow the logs + +.TP +\fB-R\fR, \fB--repo\fR \fB\fR +Filter codespace selection by repository name (user/repo) + +.TP +\fB--repo-owner\fR \fB\fR +Filter codespace selection by repository owner (username or org) + + +.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-codespace(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-ports-forward.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-ports-forward.1 new file mode 100644 index 00000000..36b911da --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-ports-forward.1 @@ -0,0 +1,43 @@ +.nh +.TH "GH-CODESPACE-PORTS-FORWARD" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-codespace-ports-forward - Forward ports + + +.SH SYNOPSIS +\fBgh codespace ports forward :... [flags]\fR + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.TP +\fB-c\fR, \fB--codespace\fR \fB\fR +Name of the codespace + +.TP +\fB-R\fR, \fB--repo\fR \fB\fR +Filter codespace selection by repository name (user/repo) + +.TP +\fB--repo-owner\fR \fB\fR +Filter codespace selection by repository owner (username or org) + + +.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-codespace-ports(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-ports-visibility.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-ports-visibility.1 new file mode 100644 index 00000000..3110c65b --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-ports-visibility.1 @@ -0,0 +1,50 @@ +.nh +.TH "GH-CODESPACE-PORTS-VISIBILITY" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-codespace-ports-visibility - Change the visibility of the forwarded port + + +.SH SYNOPSIS +\fBgh codespace ports visibility :{public|private|org}... [flags]\fR + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +.TP +\fB-c\fR, \fB--codespace\fR \fB\fR +Name of the codespace + +.TP +\fB-R\fR, \fB--repo\fR \fB\fR +Filter codespace selection by repository name (user/repo) + +.TP +\fB--repo-owner\fR \fB\fR +Filter codespace selection by repository owner (username or org) + + +.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 +$ gh codespace ports visibility 80:org 3000:private 8000:public + +.EE + + +.SH SEE ALSO +\fBgh-codespace-ports(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-ports.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-ports.1 new file mode 100644 index 00000000..63d89bd5 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-ports.1 @@ -0,0 +1,69 @@ +.nh +.TH "GH-CODESPACE-PORTS" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-codespace-ports - List ports in a codespace + + +.SH SYNOPSIS +\fBgh codespace ports [flags]\fR + + +.SH AVAILABLE COMMANDS +.TP +\fBgh-codespace-ports-forward(1)\fR +Forward ports + +.TP +\fBgh-codespace-ports-visibility(1)\fR +Change the visibility of the forwarded port + + +.SH OPTIONS +.TP +\fB-c\fR, \fB--codespace\fR \fB\fR +Name of the codespace + +.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-R\fR, \fB--repo\fR \fB\fR +Filter codespace selection by repository name (user/repo) + +.TP +\fB--repo-owner\fR \fB\fR +Filter codespace selection by repository owner (username or org) + +.TP +\fB-t\fR, \fB--template\fR \fB\fR +Format JSON output using a Go template; see "gh help formatting" + + +.SH JSON FIELDS +\fBbrowseUrl\fR, \fBlabel\fR, \fBsourcePort\fR, \fBvisibility\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-codespace(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-rebuild.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-rebuild.1 new file mode 100644 index 00000000..d13f17c2 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-rebuild.1 @@ -0,0 +1,55 @@ +.nh +.TH "GH-CODESPACE-REBUILD" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-codespace-rebuild - Rebuild a codespace + + +.SH SYNOPSIS +\fBgh codespace rebuild [flags]\fR + + +.SH DESCRIPTION +Rebuilding recreates your codespace. + +.PP +Your code and any current changes will be preserved. Your codespace will be rebuilt using +your working directory's dev container. A full rebuild also removes cached Docker images. + + +.SH OPTIONS +.TP +\fB-c\fR, \fB--codespace\fR \fB\fR +Name of the codespace + +.TP +\fB--full\fR +Perform a full rebuild + +.TP +\fB-R\fR, \fB--repo\fR \fB\fR +Filter codespace selection by repository name (user/repo) + +.TP +\fB--repo-owner\fR \fB\fR +Filter codespace selection by repository owner (username or org) + + +.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-codespace(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-ssh.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-ssh.1 new file mode 100644 index 00000000..4e026cab --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-ssh.1 @@ -0,0 +1,116 @@ +.nh +.TH "GH-CODESPACE-SSH" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-codespace-ssh - SSH into a codespace + + +.SH SYNOPSIS +\fBgh codespace ssh [...] [-- ...] []\fR + + +.SH DESCRIPTION +The \fBssh\fR command is used to SSH into a codespace. In its simplest form, you can +run \fBgh cs ssh\fR, select a codespace interactively, and connect. + +.PP +The \fBssh\fR command will automatically create a public/private ssh key pair in the +\fB~/.ssh\fR directory if you do not have an existing valid key pair. When selecting the +key pair to use, the preferred order is: +.IP " 1." 5 +Key specified by \fB-i\fR in \fB\fR +.IP " 2." 5 +Automatic key, if it already exists +.IP " 3." 5 +First valid key pair in ssh config (according to \fBssh -G\fR) +.IP " 4." 5 +Automatic key, newly created + +.PP +The \fBssh\fR command also supports deeper integration with OpenSSH using a \fB--config\fR +option that generates per-codespace ssh configuration in OpenSSH format. +Including this configuration in your \fB~/.ssh/config\fR improves the user experience +of tools that integrate with OpenSSH, such as Bash/Zsh completion of ssh hostnames, +remote path completion for \fBscp/rsync/sshfs\fR, \fBgit\fR ssh remotes, and so on. + +.PP +Once that is set up (see the second example below), you can ssh to codespaces as +if they were ordinary remote hosts (using \fBssh\fR, not \fBgh cs ssh\fR). + +.PP +Note that the codespace you are connecting to must have an SSH server pre-installed. +If the docker image being used for the codespace does not have an SSH server, +install it in your \fBDockerfile\fR or, for codespaces that use Debian-based images, +you can add the following to your \fBdevcontainer.json\fR: + +.EX +"features": { + "ghcr.io/devcontainers/features/sshd:1": { + "version": "latest" + } +} +.EE + + +.SH OPTIONS +.TP +\fB-c\fR, \fB--codespace\fR \fB\fR +Name of the codespace + +.TP +\fB--config\fR +Write OpenSSH configuration to stdout + +.TP +\fB-d\fR, \fB--debug\fR +Log debug data to a file + +.TP +\fB--debug-file\fR \fB\fR +Path of the file log to + +.TP +\fB--profile\fR \fB\fR +Name of the SSH profile to use + +.TP +\fB-R\fR, \fB--repo\fR \fB\fR +Filter codespace selection by repository name (user/repo) + +.TP +\fB--repo-owner\fR \fB\fR +Filter codespace selection by repository owner (username or org) + +.TP +\fB--server-port\fR \fB (default 0)\fR +SSH server port number (0 => pick unused) + + +.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 +$ gh codespace ssh + +$ gh codespace ssh --config > ~/.ssh/codespaces +$ printf 'Match all\\nInclude ~/.ssh/codespaces\\n' >> ~/.ssh/config + +.EE + + +.SH SEE ALSO +\fBgh-codespace(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-stop.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-stop.1 new file mode 100644 index 00000000..457053e1 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-stop.1 @@ -0,0 +1,51 @@ +.nh +.TH "GH-CODESPACE-STOP" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-codespace-stop - Stop a running codespace + + +.SH SYNOPSIS +\fBgh codespace stop [flags]\fR + + +.SH OPTIONS +.TP +\fB-c\fR, \fB--codespace\fR \fB\fR +Name of the codespace + +.TP +\fB-o\fR, \fB--org\fR \fB\fR +The login handle of the organization (admin-only) + +.TP +\fB-R\fR, \fB--repo\fR \fB\fR +Filter codespace selection by repository name (user/repo) + +.TP +\fB--repo-owner\fR \fB\fR +Filter codespace selection by repository owner (username or org) + +.TP +\fB-u\fR, \fB--user\fR \fB\fR +The username to stop codespace for (used with --org) + + +.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-codespace(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-view.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-view.1 new file mode 100644 index 00000000..2552e235 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace-view.1 @@ -0,0 +1,76 @@ +.nh +.TH "GH-CODESPACE-VIEW" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-codespace-view - View details about a codespace + + +.SH SYNOPSIS +\fBgh codespace view [flags]\fR + + +.SH OPTIONS +.TP +\fB-c\fR, \fB--codespace\fR \fB\fR +Name of the codespace + +.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-R\fR, \fB--repo\fR \fB\fR +Filter codespace selection by repository name (user/repo) + +.TP +\fB--repo-owner\fR \fB\fR +Filter codespace selection by repository owner (username or org) + +.TP +\fB-t\fR, \fB--template\fR \fB\fR +Format JSON output using a Go template; see "gh help formatting" + + +.SH JSON FIELDS +\fBbillableOwner\fR, \fBcreatedAt\fR, \fBdevcontainerPath\fR, \fBdisplayName\fR, \fBenvironmentId\fR, \fBgitStatus\fR, \fBidleTimeoutMinutes\fR, \fBlastUsedAt\fR, \fBlocation\fR, \fBmachineDisplayName\fR, \fBmachineName\fR, \fBname\fR, \fBowner\fR, \fBprebuild\fR, \fBrecentFolders\fR, \fBrepository\fR, \fBretentionExpiresAt\fR, \fBretentionPeriodDays\fR, \fBstate\fR, \fBvscsTarget\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 EXAMPLE +.EX +# Select a codespace from a list of all codespaces you own +$ gh cs view + +# View the details of a specific codespace +$ gh cs view -c codespace-name-12345 + +# View the list of all available fields for a codespace +$ gh cs view --json + +# View specific fields for a codespace +$ gh cs view --json displayName,machineDisplayName,state + +.EE + + +.SH SEE ALSO +\fBgh-codespace(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace.1 new file mode 100644 index 00000000..2d03c1cc --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-codespace.1 @@ -0,0 +1,87 @@ +.nh +.TH "GH-CODESPACE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-codespace - Connect to and manage codespaces + + +.SH SYNOPSIS +\fBgh codespace [flags]\fR + + +.SH AVAILABLE COMMANDS +.TP +\fBgh-codespace-code(1)\fR +Open a codespace in Visual Studio Code + +.TP +\fBgh-codespace-cp(1)\fR +Copy files between local and remote file systems + +.TP +\fBgh-codespace-create(1)\fR +Create a codespace + +.TP +\fBgh-codespace-delete(1)\fR +Delete codespaces + +.TP +\fBgh-codespace-edit(1)\fR +Edit a codespace + +.TP +\fBgh-codespace-jupyter(1)\fR +Open a codespace in JupyterLab + +.TP +\fBgh-codespace-list(1)\fR +List codespaces + +.TP +\fBgh-codespace-logs(1)\fR +Access codespace logs + +.TP +\fBgh-codespace-ports(1)\fR +List ports in a codespace + +.TP +\fBgh-codespace-rebuild(1)\fR +Rebuild a codespace + +.TP +\fBgh-codespace-ssh(1)\fR +SSH into a codespace + +.TP +\fBgh-codespace-stop(1)\fR +Stop a running codespace + +.TP +\fBgh-codespace-view(1)\fR +View details about a codespace + + +.SH ALIASES +gh cs + + +.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/gh_2.76.2_macOS_amd64/share/man/man1/gh-completion.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-completion.1 new file mode 100644 index 00000000..cb536c0c --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-completion.1 @@ -0,0 +1,100 @@ +.nh +.TH "GH-COMPLETION" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-completion - Generate shell completion scripts + + +.SH SYNOPSIS +\fBgh completion -s \fR + + +.SH DESCRIPTION +Generate shell completion scripts for GitHub CLI commands. + +.PP +When installing GitHub CLI through a package manager, it's possible that +no additional shell configuration is necessary to gain completion support. For +Homebrew, see +\[la]https://docs.brew.sh/Shell\-Completion\[ra] + +.PP +If you need to set up completions manually, follow the instructions below. The exact +config file locations might vary based on your system. Make sure to restart your +shell before testing whether completions are working. + +.SS bash +First, ensure that you install \fBbash-completion\fR using your package manager. + +.PP +After, add this to your \fB~/.bash_profile\fR: + +.EX +eval "$(gh completion -s bash)" +.EE + +.SS zsh +Generate a \fB_gh\fR completion script and put it somewhere in your \fB$fpath\fR: + +.EX +gh completion -s zsh > /usr/local/share/zsh/site-functions/_gh +.EE + +.PP +Ensure that the following is present in your \fB~/.zshrc\fR: + +.EX +autoload -U compinit +compinit -i +.EE + +.PP +Zsh version 5.7 or later is recommended. + +.SS fish +Generate a \fBgh.fish\fR completion script: + +.EX +gh completion -s fish > ~/.config/fish/completions/gh.fish +.EE + +.SS PowerShell +Open your profile script with: + +.EX +mkdir -Path (Split-Path -Parent $profile) -ErrorAction SilentlyContinue +notepad $profile +.EE + +.PP +Add the line and save the file: + +.EX +Invoke-Expression -Command $(gh completion -s powershell | Out-String) +.EE + + +.SH OPTIONS +.TP +\fB-s\fR, \fB--shell\fR \fB\fR +Shell type: {bash|zsh|fish|powershell} + + +.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/gh_2.76.2_macOS_amd64/share/man/man1/gh-config-clear-cache.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-config-clear-cache.1 new file mode 100644 index 00000000..ffa16c20 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-config-clear-cache.1 @@ -0,0 +1,37 @@ +.nh +.TH "GH-CONFIG-CLEAR-CACHE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-config-clear-cache - Clear the cli cache + + +.SH SYNOPSIS +\fBgh config clear-cache [flags]\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 EXAMPLE +.EX +# Clear the cli cache +$ gh config clear-cache + +.EE + + +.SH SEE ALSO +\fBgh-config(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-config-get.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-config-get.1 new file mode 100644 index 00000000..3ae05e3a --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-config-get.1 @@ -0,0 +1,42 @@ +.nh +.TH "GH-CONFIG-GET" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-config-get - Print the value of a given configuration key + + +.SH SYNOPSIS +\fBgh config get [flags]\fR + + +.SH OPTIONS +.TP +\fB-h\fR, \fB--host\fR \fB\fR +Get per-host setting + + +.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 +$ gh config get git_protocol + +.EE + + +.SH SEE ALSO +\fBgh-config(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-config-list.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-config-list.1 new file mode 100644 index 00000000..a3ca4f59 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-config-list.1 @@ -0,0 +1,39 @@ +.nh +.TH "GH-CONFIG-LIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-config-list - Print a list of configuration keys and values + + +.SH SYNOPSIS +\fBgh config list [flags]\fR + + +.SH OPTIONS +.TP +\fB-h\fR, \fB--host\fR \fB\fR +Get per-host configuration + + +.SH ALIASES +gh config 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-config(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-config-set.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-config-set.1 new file mode 100644 index 00000000..31e9d44d --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-config-set.1 @@ -0,0 +1,45 @@ +.nh +.TH "GH-CONFIG-SET" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-config-set - Update configuration with a value for the given key + + +.SH SYNOPSIS +\fBgh config set [flags]\fR + + +.SH OPTIONS +.TP +\fB-h\fR, \fB--host\fR \fB\fR +Set per-host setting + + +.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 +$ gh config set editor vim +$ gh config set editor "code --wait" +$ gh config set git_protocol ssh --host github.com +$ gh config set prompt disabled + +.EE + + +.SH SEE ALSO +\fBgh-config(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-config.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-config.1 new file mode 100644 index 00000000..1f0a0e74 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-config.1 @@ -0,0 +1,65 @@ +.nh +.TH "GH-CONFIG" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-config - Manage configuration for gh + + +.SH SYNOPSIS +\fBgh config [flags]\fR + + +.SH DESCRIPTION +Display or change configuration settings for gh. + +.PP +Current respected settings: +- \fBgit_protocol\fR: the protocol to use for git clone and push operations \fB{https | ssh}\fR (default \fBhttps\fR) +- \fBeditor\fR: the text editor program to use for authoring text +- \fBprompt\fR: toggle interactive prompting in the terminal \fB{enabled | disabled}\fR (default \fBenabled\fR) +- \fBprefer_editor_prompt\fR: toggle preference for editor-based interactive prompting in the terminal \fB{enabled | disabled}\fR (default \fBdisabled\fR) +- \fBpager\fR: the terminal pager program to send standard output to +- \fBhttp_unix_socket\fR: the path to a Unix socket through which to make an HTTP connection +- \fBbrowser\fR: the web browser to use for opening URLs +- \fBcolor_labels\fR: whether to display labels using their RGB hex color codes in terminals that support truecolor \fB{enabled | disabled}\fR (default \fBdisabled\fR) +- \fBaccessible_colors\fR: whether customizable, 4-bit accessible colors should be used \fB{enabled | disabled}\fR (default \fBdisabled\fR) +- \fBaccessible_prompter\fR: whether an accessible prompter should be used \fB{enabled | disabled}\fR (default \fBdisabled\fR) +- \fBspinner\fR: whether to use a animated spinner as a progress indicator \fB{enabled | disabled}\fR (default \fBenabled\fR) + + +.SH AVAILABLE COMMANDS +.TP +\fBgh-config-clear-cache(1)\fR +Clear the cli cache + +.TP +\fBgh-config-get(1)\fR +Print the value of a given configuration key + +.TP +\fBgh-config-list(1)\fR +Print a list of configuration keys and values + +.TP +\fBgh-config-set(1)\fR +Update configuration with a value for the given key + + +.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/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension-browse.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension-browse.1 new file mode 100644 index 00000000..ce172745 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension-browse.1 @@ -0,0 +1,67 @@ +.nh +.TH "GH-EXTENSION-BROWSE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-extension-browse - Enter a UI for browsing, adding, and removing extensions + + +.SH SYNOPSIS +\fBgh extension browse [flags]\fR + + +.SH DESCRIPTION +This command will take over your terminal and run a fully interactive +interface for browsing, adding, and removing gh extensions. A terminal +width greater than 100 columns is recommended. + +.PP +To learn how to control this interface, press \fB?\fR after running to see +the help text. + +.PP +Press \fBq\fR to quit. + +.PP +Running this command with \fB--single-column\fR should make this command +more intelligible for users who rely on assistive technology like screen +readers or high zoom. + +.PP +For a more traditional way to discover extensions, see: + +.EX +gh ext search +.EE + +.PP +along with \fBgh ext install\fR, \fBgh ext remove\fR, and \fBgh repo view\fR\&. + + +.SH OPTIONS +.TP +\fB--debug\fR +Log to /tmp/extBrowse-* + +.TP +\fB-s\fR, \fB--single-column\fR +Render TUI with only one column of text + + +.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-extension(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension-create.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension-create.1 new file mode 100644 index 00000000..7f813e59 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension-create.1 @@ -0,0 +1,52 @@ +.nh +.TH "GH-EXTENSION-CREATE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-extension-create - Create a new extension + + +.SH SYNOPSIS +\fBgh extension create [] [flags]\fR + + +.SH OPTIONS +.TP +\fB--precompiled\fR \fB\fR +Create a precompiled extension. Possible values: go, other + + +.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 +# Use interactively +$ gh extension create + +# Create a script-based extension +$ gh extension create foobar + +# Create a Go extension +$ gh extension create --precompiled=go foobar + +# Create a non-Go precompiled extension +$ gh extension create --precompiled=other foobar + +.EE + + +.SH SEE ALSO +\fBgh-extension(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension-exec.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension-exec.1 new file mode 100644 index 00000000..99875ce5 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension-exec.1 @@ -0,0 +1,47 @@ +.nh +.TH "GH-EXTENSION-EXEC" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-extension-exec - Execute an installed extension + + +.SH SYNOPSIS +\fBgh extension exec [args] [flags]\fR + + +.SH DESCRIPTION +Execute an extension using the short name. For example, if the extension repository is +\fBowner/gh-extension\fR, you should pass \fBextension\fR\&. You can use this command when +the short name conflicts with a core gh command. + +.PP +All arguments after the extension name will be forwarded to the executable +of the extension. + + +.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 +# Execute a label extension instead of the core gh label command +$ gh extension exec label + +.EE + + +.SH SEE ALSO +\fBgh-extension(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension-install.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension-install.1 new file mode 100644 index 00000000..1446c331 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension-install.1 @@ -0,0 +1,93 @@ +.nh +.TH "GH-EXTENSION-INSTALL" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-extension-install - Install a gh extension from a repository + + +.SH SYNOPSIS +\fBgh extension install [flags]\fR + + +.SH DESCRIPTION +Install a GitHub CLI extension from a GitHub or local repository. + +.PP +For GitHub repositories, the repository argument can be specified in +\fBOWNER/REPO\fR format or as a full repository URL. +The URL format is useful when the repository is not hosted on \fBgithub.com\fR\&. + +.PP +For remote repositories, the GitHub CLI first looks for the release artifacts assuming +that it's a binary extension i.e. prebuilt binaries provided as part of the release. +In the absence of a release, the repository itself is cloned assuming that it's a +script extension i.e. prebuilt executable or script exists on its root. + +.PP +The \fB--pin\fR flag may be used to specify a tag or commit for binary and script +extensions respectively, the latest version is used otherwise. + +.PP +For local repositories, often used while developing extensions, use \fB\&.\fR as the +value of the repository argument. Note the following: +.IP \(bu 2 +After installing an extension from a locally cloned repository, the GitHub CLI will +manage this extension as a symbolic link (or equivalent mechanism on Windows) pointing +to an executable file with the same name as the repository in the repository's root. +For example, if the repository is named \fBgh-foobar\fR, the symbolic link will point +to \fBgh-foobar\fR in the extension repository's root. +.IP \(bu 2 +When executing the extension, the GitHub CLI will run the executable file found +by following the symbolic link. If no executable file is found, the extension +will fail to execute. +.IP \(bu 2 +If the extension is precompiled, the executable file must be built manually and placed +in the repository's root. + +.PP +For the list of available extensions, see +\[la]https://github.com/topics/gh\-extension\[ra]\&. + + +.SH OPTIONS +.TP +\fB--force\fR +Force upgrade extension, or ignore if latest already installed + +.TP +\fB--pin\fR \fB\fR +Pin extension to a release tag or commit ref + + +.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 +# Install an extension from a remote repository hosted on GitHub +$ gh extension install owner/gh-extension + +# Install an extension from a remote repository via full URL +$ gh extension install https://my.ghes.com/owner/gh-extension + +# Install an extension from a local repository in the current working directory +$ gh extension install . + +.EE + + +.SH SEE ALSO +\fBgh-extension(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension-list.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension-list.1 new file mode 100644 index 00000000..b7ff0acb --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension-list.1 @@ -0,0 +1,33 @@ +.nh +.TH "GH-EXTENSION-LIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-extension-list - List installed extension commands + + +.SH SYNOPSIS +\fBgh extension list [flags]\fR + + +.SH ALIASES +gh ext ls, gh extension ls, gh extensions 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-extension(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension-remove.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension-remove.1 new file mode 100644 index 00000000..c05caa48 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension-remove.1 @@ -0,0 +1,29 @@ +.nh +.TH "GH-EXTENSION-REMOVE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-extension-remove - Remove an installed extension + + +.SH SYNOPSIS +\fBgh extension remove [flags]\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-extension(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension-search.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension-search.1 new file mode 100644 index 00000000..36b83553 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension-search.1 @@ -0,0 +1,138 @@ +.nh +.TH "GH-EXTENSION-SEARCH" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-extension-search - Search extensions to the GitHub CLI + + +.SH SYNOPSIS +\fBgh extension search [] [flags]\fR + + +.SH DESCRIPTION +Search for gh extensions. + +.PP +With no arguments, this command prints out the first 30 extensions +available to install sorted by number of stars. More extensions can +be fetched by specifying a higher limit with the \fB--limit\fR flag. + +.PP +When connected to a terminal, this command prints out three columns. +The first has a ✓ if the extension is already installed locally. The +second is the full name of the extension repository in \fBOWNER/REPO\fR +format. The third is the extension's description. + +.PP +When not connected to a terminal, the ✓ character is rendered as the +word "installed" but otherwise the order and content of the columns +are the same. + +.PP +This command behaves similarly to \fBgh search repos\fR but does not +support as many search qualifiers. For a finer grained search of +extensions, try using: + +.EX +gh search repos --topic "gh-extension" +.EE + +.PP +and adding qualifiers as needed. See \fBgh help search repos\fR to learn +more about repository search. + +.PP +For listing just the extensions that are already installed locally, +see: + +.EX +gh ext list +.EE + + +.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--license\fR \fB\fR +Filter based on license type + +.TP +\fB-L\fR, \fB--limit\fR \fB (default 30)\fR +Maximum number of extensions to fetch + +.TP +\fB--order\fR \fB (default "desc")\fR +Order of repositories returned, ignored unless '--sort' flag is specified: {asc|desc} + +.TP +\fB--owner\fR \fB\fR +Filter on owner + +.TP +\fB--sort\fR \fB (default "best-match")\fR +Sort fetched repositories: {forks|help-wanted-issues|stars|updated} + +.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 +Open the search query in the web browser + + +.SH JSON FIELDS +\fBcreatedAt\fR, \fBdefaultBranch\fR, \fBdescription\fR, \fBforksCount\fR, \fBfullName\fR, \fBhasDownloads\fR, \fBhasIssues\fR, \fBhasPages\fR, \fBhasProjects\fR, \fBhasWiki\fR, \fBhomepage\fR, \fBid\fR, \fBisArchived\fR, \fBisDisabled\fR, \fBisFork\fR, \fBisPrivate\fR, \fBlanguage\fR, \fBlicense\fR, \fBname\fR, \fBopenIssuesCount\fR, \fBowner\fR, \fBpushedAt\fR, \fBsize\fR, \fBstargazersCount\fR, \fBupdatedAt\fR, \fBurl\fR, \fBvisibility\fR, \fBwatchersCount\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 EXAMPLE +.EX +# List the first 30 extensions sorted by star count, descending +$ gh ext search + +# List more extensions +$ gh ext search --limit 300 + +# List extensions matching the term "branch" +$ gh ext search branch + +# List extensions owned by organization "github" +$ gh ext search --owner github + +# List extensions, sorting by recently updated, ascending +$ gh ext search --sort updated --order asc + +# List extensions, filtering by license +$ gh ext search --license MIT + +# Open search results in the browser +$ gh ext search -w + +.EE + + +.SH SEE ALSO +\fBgh-extension(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension-upgrade.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension-upgrade.1 new file mode 100644 index 00000000..2dbbbca7 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension-upgrade.1 @@ -0,0 +1,43 @@ +.nh +.TH "GH-EXTENSION-UPGRADE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-extension-upgrade - Upgrade installed extensions + + +.SH SYNOPSIS +\fBgh extension upgrade { | --all} [flags]\fR + + +.SH OPTIONS +.TP +\fB--all\fR +Upgrade all extensions + +.TP +\fB--dry-run\fR +Only display upgrades + +.TP +\fB--force\fR +Force upgrade extension + + +.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-extension(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension.1 new file mode 100644 index 00000000..58a829a9 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-extension.1 @@ -0,0 +1,88 @@ +.nh +.TH "GH-EXTENSION" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-extension - Manage gh extensions + + +.SH SYNOPSIS +\fBgh extension [flags]\fR + + +.SH DESCRIPTION +GitHub CLI extensions are repositories that provide additional gh commands. + +.PP +The name of the extension repository must start with \fBgh-\fR and it must contain an +executable of the same name. All arguments passed to the \fBgh \fR invocation +will be forwarded to the \fBgh-\fR executable of the extension. + +.PP +An extension cannot override any of the core gh commands. If an extension name conflicts +with a core gh command, you can use \fBgh extension exec \fR\&. + +.PP +When an extension is executed, gh will check for new versions once every 24 hours and display +an upgrade notice. See \fBgh help environment\fR for information on disabling extension notices. + +.PP +For the list of available extensions, see +\[la]https://github.com/topics/gh\-extension\[ra]\&. + + +.SH AVAILABLE COMMANDS +.TP +\fBgh-extension-browse(1)\fR +Enter a UI for browsing, adding, and removing extensions + +.TP +\fBgh-extension-create(1)\fR +Create a new extension + +.TP +\fBgh-extension-exec(1)\fR +Execute an installed extension + +.TP +\fBgh-extension-install(1)\fR +Install a gh extension from a repository + +.TP +\fBgh-extension-list(1)\fR +List installed extension commands + +.TP +\fBgh-extension-remove(1)\fR +Remove an installed extension + +.TP +\fBgh-extension-search(1)\fR +Search extensions to the GitHub CLI + +.TP +\fBgh-extension-upgrade(1)\fR +Upgrade installed extensions + + +.SH ALIASES +gh extensions, gh ext + + +.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/gh_2.76.2_macOS_amd64/share/man/man1/gh-gist-clone.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-gist-clone.1 new file mode 100644 index 00000000..140105f6 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-gist-clone.1 @@ -0,0 +1,41 @@ +.nh +.TH "GH-GIST-CLONE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-gist-clone - Clone a gist locally + + +.SH SYNOPSIS +\fBgh gist clone [] [-- ...]\fR + + +.SH DESCRIPTION +Clone a GitHub gist locally. + +.PP +A gist can be supplied as argument in either of the following formats: +- by ID, e.g. \fB5b0e0062eb8e9654adad7bb1d81cc75f\fR +- by URL, e.g. \fBhttps://gist.github.com/OWNER/5b0e0062eb8e9654adad7bb1d81cc75f\fR + +.PP +Pass additional \fBgit clone\fR flags by listing them after \fB--\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-gist(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-gist-create.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-gist-create.1 new file mode 100644 index 00000000..9c9d25e3 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-gist-create.1 @@ -0,0 +1,85 @@ +.nh +.TH "GH-GIST-CREATE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-gist-create - Create a new gist + + +.SH SYNOPSIS +\fBgh gist create [... | ... | -] [flags]\fR + + +.SH DESCRIPTION +Create a new GitHub gist with given contents. + +.PP +Gists can be created from one or multiple files. Alternatively, pass \fB-\fR as +filename to read from standard input. + +.PP +By default, gists are secret; use \fB--public\fR to make publicly listed ones. + + +.SH OPTIONS +.TP +\fB-d\fR, \fB--desc\fR \fB\fR +A description for this gist + +.TP +\fB-f\fR, \fB--filename\fR \fB\fR +Provide a filename to be used when reading from standard input + +.TP +\fB-p\fR, \fB--public\fR +List the gist publicly (default "secret") + +.TP +\fB-w\fR, \fB--web\fR +Open the web browser with created gist + + +.SH ALIASES +gh gist 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 +# Publish file 'hello.py' as a public gist +$ gh gist create --public hello.py + +# Create a gist with a description +$ gh gist create hello.py -d "my Hello-World program in Python" + +# Create a gist containing several files +$ gh gist create hello.py world.py cool.txt + +# Create a gist containing several files using patterns +$ gh gist create *.md *.txt artifact.* + +# Read from standard input to create a gist +$ gh gist create - + +# Create a gist from output piped from another command +$ cat cool.txt | gh gist create + +.EE + + +.SH SEE ALSO +\fBgh-gist(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-gist-delete.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-gist-delete.1 new file mode 100644 index 00000000..cf3f1e22 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-gist-delete.1 @@ -0,0 +1,56 @@ +.nh +.TH "GH-GIST-DELETE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-gist-delete - Delete a gist + + +.SH SYNOPSIS +\fBgh gist delete { | } [flags]\fR + + +.SH DESCRIPTION +Delete a GitHub gist. + +.PP +To delete a gist interactively, use \fBgh gist delete\fR with no arguments. + +.PP +To delete a gist non-interactively, supply the gist id or url. + + +.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 EXAMPLE +.EX +# Delete a gist interactively +$ gh gist delete + +# Delete a gist non-interactively +$ gh gist delete 1234 + +.EE + + +.SH SEE ALSO +\fBgh-gist(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-gist-edit.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-gist-edit.1 new file mode 100644 index 00000000..d5c55713 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-gist-edit.1 @@ -0,0 +1,47 @@ +.nh +.TH "GH-GIST-EDIT" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-gist-edit - Edit one of your gists + + +.SH SYNOPSIS +\fBgh gist edit { | } [] [flags]\fR + + +.SH OPTIONS +.TP +\fB-a\fR, \fB--add\fR \fB\fR +Add a new file to the gist + +.TP +\fB-d\fR, \fB--desc\fR \fB\fR +New description for the gist + +.TP +\fB-f\fR, \fB--filename\fR \fB\fR +Select a file to edit + +.TP +\fB-r\fR, \fB--remove\fR \fB\fR +Remove a file from the gist + + +.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-gist(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-gist-list.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-gist-list.1 new file mode 100644 index 00000000..eae7285a --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-gist-list.1 @@ -0,0 +1,92 @@ +.nh +.TH "GH-GIST-LIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-gist-list - List your gists + + +.SH SYNOPSIS +\fBgh gist list [flags]\fR + + +.SH DESCRIPTION +List gists from your user account. + +.PP +You can use a regular expression to filter the description, file names, +or even the content of files in the gist using \fB--filter\fR\&. + +.PP +For supported regular expression syntax, see +\[la]https://pkg.go.dev/regexp/syntax\[ra]\&. + +.PP +Use \fB--include-content\fR to include content of files, noting that +this will be slower and increase the rate limit used. Instead of printing a table, +code will be printed with highlights similar to \fBgh search code\fR: + +.EX +{{gist ID}} {{file name}} + {{description}} + {{matching lines from content}} +.EE + +.PP +No highlights or other color is printed when output is redirected. + + +.SH OPTIONS +.TP +\fB--filter\fR \fB\fR +Filter gists using a regular expression + +.TP +\fB--include-content\fR +Include gists' file content when filtering + +.TP +\fB-L\fR, \fB--limit\fR \fB (default 10)\fR +Maximum number of gists to fetch + +.TP +\fB--public\fR +Show only public gists + +.TP +\fB--secret\fR +Show only secret gists + + +.SH ALIASES +gh gist 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 EXAMPLE +.EX +# List all secret gists from your user account +$ gh gist list --secret + +# Find all gists from your user account mentioning "octo" anywhere +$ gh gist list --filter octo --include-content + +.EE + + +.SH SEE ALSO +\fBgh-gist(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-gist-rename.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-gist-rename.1 new file mode 100644 index 00000000..4dfd0cd2 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-gist-rename.1 @@ -0,0 +1,33 @@ +.nh +.TH "GH-GIST-RENAME" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-gist-rename - Rename a file in a gist + + +.SH SYNOPSIS +\fBgh gist rename { | } [flags]\fR + + +.SH DESCRIPTION +Rename a file in the given gist ID / URL. + + +.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-gist(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-gist-view.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-gist-view.1 new file mode 100644 index 00000000..0f00da73 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-gist-view.1 @@ -0,0 +1,51 @@ +.nh +.TH "GH-GIST-VIEW" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-gist-view - View a gist + + +.SH SYNOPSIS +\fBgh gist view [ | ] [flags]\fR + + +.SH DESCRIPTION +View the given gist or select from recent gists. + + +.SH OPTIONS +.TP +\fB-f\fR, \fB--filename\fR \fB\fR +Display a single file from the gist + +.TP +\fB--files\fR +List file names from the gist + +.TP +\fB-r\fR, \fB--raw\fR +Print raw instead of rendered gist contents + +.TP +\fB-w\fR, \fB--web\fR +Open gist in the browser + + +.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-gist(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-gist.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-gist.1 new file mode 100644 index 00000000..c9eef220 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-gist.1 @@ -0,0 +1,63 @@ +.nh +.TH "GH-GIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-gist - Manage gists + + +.SH SYNOPSIS +\fBgh gist [flags]\fR + + +.SH DESCRIPTION +Work with GitHub gists. + + +.SH AVAILABLE COMMANDS +.TP +\fBgh-gist-clone(1)\fR +Clone a gist locally + +.TP +\fBgh-gist-create(1)\fR +Create a new gist + +.TP +\fBgh-gist-delete(1)\fR +Delete a gist + +.TP +\fBgh-gist-edit(1)\fR +Edit one of your gists + +.TP +\fBgh-gist-list(1)\fR +List your gists + +.TP +\fBgh-gist-rename(1)\fR +Rename a file in a gist + +.TP +\fBgh-gist-view(1)\fR +View a gist + + +.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/gh_2.76.2_macOS_amd64/share/man/man1/gh-gpg-key-add.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-gpg-key-add.1 new file mode 100644 index 00000000..5f83c7f8 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-gpg-key-add.1 @@ -0,0 +1,35 @@ +.nh +.TH "GH-GPG-KEY-ADD" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-gpg-key-add - Add a GPG key to your GitHub account + + +.SH SYNOPSIS +\fBgh gpg-key add [] [flags]\fR + + +.SH OPTIONS +.TP +\fB-t\fR, \fB--title\fR \fB\fR +Title for the new key + + +.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-gpg-key(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-gpg-key-delete.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-gpg-key-delete.1 new file mode 100644 index 00000000..552a8963 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-gpg-key-delete.1 @@ -0,0 +1,35 @@ +.nh +.TH "GH-GPG-KEY-DELETE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-gpg-key-delete - Delete a GPG key from your GitHub account + + +.SH SYNOPSIS +\fBgh gpg-key delete [flags]\fR + + +.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-gpg-key(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-gpg-key-list.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-gpg-key-list.1 new file mode 100644 index 00000000..37068357 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-gpg-key-list.1 @@ -0,0 +1,33 @@ +.nh +.TH "GH-GPG-KEY-LIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-gpg-key-list - Lists GPG keys in your GitHub account + + +.SH SYNOPSIS +\fBgh gpg-key list [flags]\fR + + +.SH ALIASES +gh gpg-key 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-gpg-key(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-gpg-key.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-gpg-key.1 new file mode 100644 index 00000000..e9641ddd --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-gpg-key.1 @@ -0,0 +1,47 @@ +.nh +.TH "GH-GPG-KEY" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-gpg-key - Manage GPG keys + + +.SH SYNOPSIS +\fBgh gpg-key [flags]\fR + + +.SH DESCRIPTION +Manage GPG keys registered with your GitHub account. + + +.SH AVAILABLE COMMANDS +.TP +\fBgh-gpg-key-add(1)\fR +Add a GPG key to your GitHub account + +.TP +\fBgh-gpg-key-delete(1)\fR +Delete a GPG key from your GitHub account + +.TP +\fBgh-gpg-key-list(1)\fR +Lists GPG keys in your GitHub account + + +.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/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-close.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-close.1 new file mode 100644 index 00000000..73ed9cf3 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-close.1 @@ -0,0 +1,45 @@ +.nh +.TH "GH-ISSUE-CLOSE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-issue-close - Close issue + + +.SH SYNOPSIS +\fBgh issue close { | } [flags]\fR + + +.SH OPTIONS +.TP +\fB-c\fR, \fB--comment\fR \fB\fR +Leave a closing comment + +.TP +\fB-r\fR, \fB--reason\fR \fB\fR +Reason for closing: {completed|not planned} + + +.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-issue(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-comment.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-comment.1 new file mode 100644 index 00000000..955c664e --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-comment.1 @@ -0,0 +1,84 @@ +.nh +.TH "GH-ISSUE-COMMENT" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-issue-comment - Add a comment to an issue + + +.SH SYNOPSIS +\fBgh issue comment { | } [flags]\fR + + +.SH DESCRIPTION +Add a comment to a GitHub issue. + +.PP +Without the body text supplied through flags, the command will interactively +prompt for the comment text. + + +.SH OPTIONS +.TP +\fB-b\fR, \fB--body\fR \fB\fR +The comment body text + +.TP +\fB-F\fR, \fB--body-file\fR \fB\fR +Read body text from file (use "-" to read from standard input) + +.TP +\fB--create-if-none\fR +Create a new comment if no comments are found. Can be used only with --edit-last + +.TP +\fB--delete-last\fR +Delete the last comment of the current user + +.TP +\fB--edit-last\fR +Edit the last comment of the current user + +.TP +\fB-e\fR, \fB--editor\fR +Skip prompts and open the text editor to write the body in + +.TP +\fB-w\fR, \fB--web\fR +Open the web browser to write the comment + +.TP +\fB--yes\fR +Skip the delete confirmation prompt when --delete-last is provided + + +.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 +$ gh issue comment 12 --body "Hi from GitHub CLI" + +.EE + + +.SH SEE ALSO +\fBgh-issue(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-create.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-create.1 new file mode 100644 index 00000000..664b56a0 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-create.1 @@ -0,0 +1,112 @@ +.nh +.TH "GH-ISSUE-CREATE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-issue-create - Create a new issue + + +.SH SYNOPSIS +\fBgh issue create [flags]\fR + + +.SH DESCRIPTION +Create an issue on GitHub. + +.PP +Adding an issue to projects requires authorization with the \fBproject\fR scope. +To authorize, run \fBgh auth refresh -s project\fR\&. + +.PP +The \fB--assignee\fR flag supports the following special values: +- \fB@me\fR: assign yourself +- \fB@copilot\fR: assign Copilot (not supported on GitHub Enterprise Server) + + +.SH OPTIONS +.TP +\fB-a\fR, \fB--assignee\fR \fB\fR +Assign people by their login. Use "@me" to self-assign. + +.TP +\fB-b\fR, \fB--body\fR \fB\fR +Supply a body. Will prompt for one otherwise. + +.TP +\fB-F\fR, \fB--body-file\fR \fB\fR +Read body text from file (use "-" to read from standard input) + +.TP +\fB-e\fR, \fB--editor\fR +Skip prompts and open the text editor to write the title and body in. The first line is the title and the remaining text is the body. + +.TP +\fB-l\fR, \fB--label\fR \fB\fR +Add labels by name + +.TP +\fB-m\fR, \fB--milestone\fR \fB\fR +Add the issue to a milestone by name + +.TP +\fB-p\fR, \fB--project\fR \fB\fR +Add the issue to projects by title + +.TP +\fB--recover\fR \fB<string>\fR +Recover input from a failed run of create + +.TP +\fB-T\fR, \fB--template\fR \fB<name>\fR +Template name to use as starting body text + +.TP +\fB-t\fR, \fB--title\fR \fB<string>\fR +Supply a title. Will prompt for one otherwise. + +.TP +\fB-w\fR, \fB--web\fR +Open the browser to create an issue + + +.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 issue 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 +$ gh issue create --title "I found a bug" --body "Nothing works" +$ gh issue create --label "bug,help wanted" +$ gh issue create --label bug --label "help wanted" +$ gh issue create --assignee monalisa,hubot +$ gh issue create --assignee "@me" +$ gh issue create --assignee "@copilot" +$ gh issue create --project "Roadmap" +$ gh issue create --template "Bug Report" + +.EE + + +.SH SEE ALSO +\fBgh-issue(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-delete.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-delete.1 new file mode 100644 index 00000000..f9f6545b --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-delete.1 @@ -0,0 +1,41 @@ +.nh +.TH "GH-ISSUE-DELETE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-issue-delete - Delete issue + + +.SH SYNOPSIS +\fBgh issue delete {<number> | <url>} [flags]\fR + + +.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-issue(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-develop.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-develop.1 new file mode 100644 index 00000000..f7547942 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-develop.1 @@ -0,0 +1,86 @@ +.nh +.TH "GH-ISSUE-DEVELOP" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-issue-develop - Manage linked branches for an issue + + +.SH SYNOPSIS +\fBgh issue develop {<number> | <url>} [flags]\fR + + +.SH DESCRIPTION +Manage linked branches for an issue. + +.PP +When using the \fB--base\fR flag, the new development branch will be created from the specified +remote branch. The new branch will be configured as the base branch for pull requests created using +\fBgh pr create\fR\&. + + +.SH OPTIONS +.TP +\fB-b\fR, \fB--base\fR \fB<string>\fR +Name of the remote branch you want to make your new branch from + +.TP +\fB--branch-repo\fR \fB<string>\fR +Name or URL of the repository where you want to create your new branch + +.TP +\fB-c\fR, \fB--checkout\fR +Checkout the branch after creating it + +.TP +\fB-l\fR, \fB--list\fR +List linked branches for the issue + +.TP +\fB-n\fR, \fB--name\fR \fB<string>\fR +Name of the branch to create + + +.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 +# List branches for issue 123 +$ gh issue develop --list 123 + +# List branches for issue 123 in repo cli/cli +$ gh issue develop --list --repo cli/cli 123 + +# Create a branch for issue 123 based on the my-feature branch +$ gh issue develop 123 --base my-feature + +# Create a branch for issue 123 and checkout it out +$ gh issue develop 123 --checkout + +# Create a branch in repo monalisa/cli for issue 123 in repo cli/cli +$ gh issue develop 123 --repo cli/cli --branch-repo monalisa/cli + +.EE + + +.SH SEE ALSO +\fBgh-issue(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-edit.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-edit.1 new file mode 100644 index 00000000..40fcea5e --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-edit.1 @@ -0,0 +1,110 @@ +.nh +.TH "GH-ISSUE-EDIT" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-issue-edit - Edit issues + + +.SH SYNOPSIS +\fBgh issue edit {<numbers> | <urls>} [flags]\fR + + +.SH DESCRIPTION +Edit one or more issues within the same repository. + +.PP +Editing issues' projects requires authorization with the \fBproject\fR scope. +To authorize, run \fBgh auth refresh -s project\fR\&. + +.PP +The \fB--add-assignee\fR and \fB--remove-assignee\fR flags both support +the following special values: +- \fB@me\fR: assign or unassign yourself +- \fB@copilot\fR: assign or unassign Copilot (not supported on GitHub Enterprise Server) + + +.SH OPTIONS +.TP +\fB--add-assignee\fR \fB<login>\fR +Add assigned users by their login. Use "@me" to assign yourself, or "@copilot" to assign Copilot. + +.TP +\fB--add-label\fR \fB<name>\fR +Add labels by name + +.TP +\fB--add-project\fR \fB<title>\fR +Add the issue to projects by title + +.TP +\fB-b\fR, \fB--body\fR \fB<string>\fR +Set the new body. + +.TP +\fB-F\fR, \fB--body-file\fR \fB<file>\fR +Read body text from file (use "-" to read from standard input) + +.TP +\fB-m\fR, \fB--milestone\fR \fB<name>\fR +Edit the milestone the issue belongs to by name + +.TP +\fB--remove-assignee\fR \fB<login>\fR +Remove assigned users by their login. Use "@me" to unassign yourself, or "@copilot" to unassign Copilot. + +.TP +\fB--remove-label\fR \fB<name>\fR +Remove labels by name + +.TP +\fB--remove-milestone\fR +Remove the milestone association from the issue + +.TP +\fB--remove-project\fR \fB<title>\fR +Remove the issue from projects by title + +.TP +\fB-t\fR, \fB--title\fR \fB<string>\fR +Set the new title. + + +.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 +$ gh issue edit 23 --title "I found a bug" --body "Nothing works" +$ gh issue edit 23 --add-label "bug,help wanted" --remove-label "core" +$ gh issue edit 23 --add-assignee "@me" --remove-assignee monalisa,hubot +$ gh issue edit 23 --add-assignee "@copilot" +$ gh issue edit 23 --add-project "Roadmap" --remove-project v1,v2 +$ gh issue edit 23 --milestone "Version 1" +$ gh issue edit 23 --remove-milestone +$ gh issue edit 23 --body-file body.txt +$ gh issue edit 23 34 --add-label "help wanted" + +.EE + + +.SH SEE ALSO +\fBgh-issue(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-list.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-list.1 new file mode 100644 index 00000000..1e76ccfb --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-list.1 @@ -0,0 +1,118 @@ +.nh +.TH "GH-ISSUE-LIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-issue-list - List issues in a repository + + +.SH SYNOPSIS +\fBgh issue list [flags]\fR + + +.SH DESCRIPTION +List issues in a GitHub repository. By default, this only lists open issues. + +.PP +The search query syntax is documented here: + +\[la]https://docs.github.com/en/search\-github/searching\-on\-github/searching\-issues\-and\-pull\-requests\[ra] + + +.SH OPTIONS +.TP +\fB--app\fR \fB<string>\fR +Filter by GitHub App author + +.TP +\fB-a\fR, \fB--assignee\fR \fB<string>\fR +Filter by assignee + +.TP +\fB-A\fR, \fB--author\fR \fB<string>\fR +Filter by author + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB<fields>\fR +Output JSON with the specified fields + +.TP +\fB-l\fR, \fB--label\fR \fB<strings>\fR +Filter by label + +.TP +\fB-L\fR, \fB--limit\fR \fB<int> (default 30)\fR +Maximum number of issues to fetch + +.TP +\fB--mention\fR \fB<string>\fR +Filter by mention + +.TP +\fB-m\fR, \fB--milestone\fR \fB<string>\fR +Filter by milestone number or title + +.TP +\fB-S\fR, \fB--search\fR \fB<query>\fR +Search issues with query + +.TP +\fB-s\fR, \fB--state\fR \fB<string> (default "open")\fR +Filter by state: {open|closed|all} + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB-w\fR, \fB--web\fR +List issues 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 issue ls + + +.SH JSON FIELDS +\fBassignees\fR, \fBauthor\fR, \fBbody\fR, \fBclosed\fR, \fBclosedAt\fR, \fBclosedByPullRequestsReferences\fR, \fBcomments\fR, \fBcreatedAt\fR, \fBid\fR, \fBisPinned\fR, \fBlabels\fR, \fBmilestone\fR, \fBnumber\fR, \fBprojectCards\fR, \fBprojectItems\fR, \fBreactionGroups\fR, \fBstate\fR, \fBstateReason\fR, \fBtitle\fR, \fBupdatedAt\fR, \fBurl\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 EXAMPLE +.EX +$ gh issue list --label "bug" --label "help wanted" +$ gh issue list --author monalisa +$ gh issue list --assignee "@me" +$ gh issue list --milestone "The big 1.0" +$ gh issue list --search "error no:assignee sort:created-asc" +$ gh issue list --state all + +.EE + + +.SH SEE ALSO +\fBgh-issue(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-lock.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-lock.1 new file mode 100644 index 00000000..f393d1a2 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-lock.1 @@ -0,0 +1,41 @@ +.nh +.TH "GH-ISSUE-LOCK" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-issue-lock - Lock issue conversation + + +.SH SYNOPSIS +\fBgh issue lock {<number> | <url>} [flags]\fR + + +.SH OPTIONS +.TP +\fB-r\fR, \fB--reason\fR \fB<string>\fR +Optional reason for locking conversation (off_topic, resolved, spam, too_heated). + + +.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-issue(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-pin.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-pin.1 new file mode 100644 index 00000000..68ac38b6 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-pin.1 @@ -0,0 +1,56 @@ +.nh +.TH "GH-ISSUE-PIN" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-issue-pin - Pin a issue + + +.SH SYNOPSIS +\fBgh issue pin {<number> | <url>} [flags]\fR + + +.SH DESCRIPTION +Pin an issue to a repository. + +.PP +The issue can be specified by issue number or URL. + + +.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 +# Pin an issue to the current repository +$ gh issue pin 23 + +# Pin an issue by URL +$ gh issue pin https://github.com/owner/repo/issues/23 + +# Pin an issue to specific repository +$ gh issue pin 23 --repo owner/repo + +.EE + + +.SH SEE ALSO +\fBgh-issue(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-reopen.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-reopen.1 new file mode 100644 index 00000000..52bdfb63 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-reopen.1 @@ -0,0 +1,41 @@ +.nh +.TH "GH-ISSUE-REOPEN" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-issue-reopen - Reopen issue + + +.SH SYNOPSIS +\fBgh issue reopen {<number> | <url>} [flags]\fR + + +.SH OPTIONS +.TP +\fB-c\fR, \fB--comment\fR \fB<string>\fR +Add a reopening comment + + +.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-issue(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-status.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-status.1 new file mode 100644 index 00000000..c39b34d4 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-status.1 @@ -0,0 +1,53 @@ +.nh +.TH "GH-ISSUE-STATUS" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-issue-status - Show status of relevant issues + + +.SH SYNOPSIS +\fBgh issue status [flags]\fR + + +.SH OPTIONS +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB<fields>\fR +Output JSON with the specified fields + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\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 +\fBassignees\fR, \fBauthor\fR, \fBbody\fR, \fBclosed\fR, \fBclosedAt\fR, \fBclosedByPullRequestsReferences\fR, \fBcomments\fR, \fBcreatedAt\fR, \fBid\fR, \fBisPinned\fR, \fBlabels\fR, \fBmilestone\fR, \fBnumber\fR, \fBprojectCards\fR, \fBprojectItems\fR, \fBreactionGroups\fR, \fBstate\fR, \fBstateReason\fR, \fBtitle\fR, \fBupdatedAt\fR, \fBurl\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-issue(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-transfer.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-transfer.1 new file mode 100644 index 00000000..0c4adadf --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-transfer.1 @@ -0,0 +1,35 @@ +.nh +.TH "GH-ISSUE-TRANSFER" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-issue-transfer - Transfer issue to another repository + + +.SH SYNOPSIS +\fBgh issue transfer {<number> | <url>} <destination-repo> [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-issue(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-unlock.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-unlock.1 new file mode 100644 index 00000000..f9fa8b45 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-unlock.1 @@ -0,0 +1,35 @@ +.nh +.TH "GH-ISSUE-UNLOCK" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-issue-unlock - Unlock issue conversation + + +.SH SYNOPSIS +\fBgh issue unlock {<number> | <url>} [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-issue(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-unpin.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-unpin.1 new file mode 100644 index 00000000..aa0efc29 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-unpin.1 @@ -0,0 +1,56 @@ +.nh +.TH "GH-ISSUE-UNPIN" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-issue-unpin - Unpin a issue + + +.SH SYNOPSIS +\fBgh issue unpin {<number> | <url>} [flags]\fR + + +.SH DESCRIPTION +Unpin an issue from a repository. + +.PP +The issue can be specified by issue number or URL. + + +.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 +# Unpin issue from the current repository +$ gh issue unpin 23 + +# Unpin issue by URL +$ gh issue unpin https://github.com/owner/repo/issues/23 + +# Unpin an issue from specific repository +$ gh issue unpin 23 --repo owner/repo + +.EE + + +.SH SEE ALSO +\fBgh-issue(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-view.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-view.1 new file mode 100644 index 00000000..89b16bcb --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue-view.1 @@ -0,0 +1,68 @@ +.nh +.TH "GH-ISSUE-VIEW" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-issue-view - View an issue + + +.SH SYNOPSIS +\fBgh issue view {<number> | <url>} [flags]\fR + + +.SH DESCRIPTION +Display the title, body, and other information about an issue. + +.PP +With \fB--web\fR flag, open the issue in a web browser instead. + + +.SH OPTIONS +.TP +\fB-c\fR, \fB--comments\fR +View issue comments + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB<fields>\fR +Output JSON with the specified fields + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB-w\fR, \fB--web\fR +Open an issue in the 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 JSON FIELDS +\fBassignees\fR, \fBauthor\fR, \fBbody\fR, \fBclosed\fR, \fBclosedAt\fR, \fBclosedByPullRequestsReferences\fR, \fBcomments\fR, \fBcreatedAt\fR, \fBid\fR, \fBisPinned\fR, \fBlabels\fR, \fBmilestone\fR, \fBnumber\fR, \fBprojectCards\fR, \fBprojectItems\fR, \fBreactionGroups\fR, \fBstate\fR, \fBstateReason\fR, \fBtitle\fR, \fBupdatedAt\fR, \fBurl\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-issue(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue.1 new file mode 100644 index 00000000..c8d0a99b --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-issue.1 @@ -0,0 +1,112 @@ +.nh +.TH "GH-ISSUE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-issue - Manage issues + + +.SH SYNOPSIS +\fBgh issue <command> [flags]\fR + + +.SH DESCRIPTION +Work with GitHub issues. + + +.SH GENERAL COMMANDS +.TP +\fBgh-issue-create(1)\fR +Create a new issue + +.TP +\fBgh-issue-list(1)\fR +List issues in a repository + +.TP +\fBgh-issue-status(1)\fR +Show status of relevant issues + + +.SH TARGETED COMMANDS +.TP +\fBgh-issue-close(1)\fR +Close issue + +.TP +\fBgh-issue-comment(1)\fR +Add a comment to an issue + +.TP +\fBgh-issue-delete(1)\fR +Delete issue + +.TP +\fBgh-issue-develop(1)\fR +Manage linked branches for an issue + +.TP +\fBgh-issue-edit(1)\fR +Edit issues + +.TP +\fBgh-issue-lock(1)\fR +Lock issue conversation + +.TP +\fBgh-issue-pin(1)\fR +Pin a issue + +.TP +\fBgh-issue-reopen(1)\fR +Reopen issue + +.TP +\fBgh-issue-transfer(1)\fR +Transfer issue to another repository + +.TP +\fBgh-issue-unlock(1)\fR +Unlock issue conversation + +.TP +\fBgh-issue-unpin(1)\fR +Unpin a issue + +.TP +\fBgh-issue-view(1)\fR +View an issue + + +.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 EXAMPLE +.EX +$ gh issue list +$ gh issue create --label bug +$ gh issue view 123 --web + +.EE + + +.SH SEE ALSO +\fBgh(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-label-clone.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-label-clone.1 new file mode 100644 index 00000000..67cf2642 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-label-clone.1 @@ -0,0 +1,67 @@ +.nh +.TH "GH-LABEL-CLONE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-label-clone - Clones labels from one repository to another + + +.SH SYNOPSIS +\fBgh label clone <source-repository> [flags]\fR + + +.SH DESCRIPTION +Clones labels from a source repository to a destination repository on GitHub. +By default, the destination repository is the current repository. + +.PP +All labels from the source repository will be copied to the destination +repository. Labels in the destination repository that are not in the source +repository will not be deleted or modified. + +.PP +Labels from the source repository that already exist in the destination +repository will be skipped. You can overwrite existing labels in the +destination repository using the \fB--force\fR flag. + + +.SH OPTIONS +.TP +\fB-f\fR, \fB--force\fR +Overwrite labels in the destination repository + + +.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 +# Clone and overwrite labels from cli/cli repository into the current repository +$ gh label clone cli/cli --force + +# Clone labels from cli/cli repository into a octocat/cli repository +$ gh label clone cli/cli --repo octocat/cli + +.EE + + +.SH SEE ALSO +\fBgh-label(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-label-create.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-label-create.1 new file mode 100644 index 00000000..c834e93e --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-label-create.1 @@ -0,0 +1,68 @@ +.nh +.TH "GH-LABEL-CREATE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-label-create - Create a new label + + +.SH SYNOPSIS +\fBgh label create <name> [flags]\fR + + +.SH DESCRIPTION +Create a new label on GitHub, or update an existing one with \fB--force\fR\&. + +.PP +Must specify name for the label. The description and color are optional. +If a color isn't provided, a random one will be chosen. + +.PP +The label color needs to be 6 character hex value. + + +.SH OPTIONS +.TP +\fB-c\fR, \fB--color\fR \fB<string>\fR +Color of the label + +.TP +\fB-d\fR, \fB--description\fR \fB<string>\fR +Description of the label + +.TP +\fB-f\fR, \fB--force\fR +Update the label color and description if label already exists + + +.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 +# Create new bug label +$ gh label create bug --description "Something isn't working" --color E99695 + +.EE + + +.SH SEE ALSO +\fBgh-label(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-label-delete.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-label-delete.1 new file mode 100644 index 00000000..45f63f00 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-label-delete.1 @@ -0,0 +1,41 @@ +.nh +.TH "GH-LABEL-DELETE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-label-delete - Delete a label from a repository + + +.SH SYNOPSIS +\fBgh label delete <name> [flags]\fR + + +.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-label(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-label-edit.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-label-edit.1 new file mode 100644 index 00000000..24013fd0 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-label-edit.1 @@ -0,0 +1,70 @@ +.nh +.TH "GH-LABEL-EDIT" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-label-edit - Edit a label + + +.SH SYNOPSIS +\fBgh label edit <name> [flags]\fR + + +.SH DESCRIPTION +Update a label on GitHub. + +.PP +A label can be renamed using the \fB--name\fR flag. + +.PP +The label color needs to be 6 character hex value. + + +.SH OPTIONS +.TP +\fB-c\fR, \fB--color\fR \fB<string>\fR +Color of the label + +.TP +\fB-d\fR, \fB--description\fR \fB<string>\fR +Description of the label + +.TP +\fB-n\fR, \fB--name\fR \fB<string>\fR +New name of the label + + +.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 +# Update the color of the bug label +$ gh label edit bug --color FF0000 + +# Rename and edit the description of the bug label +$ gh label edit bug --name big-bug --description "Bigger than normal bug" + +.EE + + +.SH SEE ALSO +\fBgh-label(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-label-list.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-label-list.1 new file mode 100644 index 00000000..dea830b0 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-label-list.1 @@ -0,0 +1,96 @@ +.nh +.TH "GH-LABEL-LIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-label-list - List labels in a repository + + +.SH SYNOPSIS +\fBgh label list [flags]\fR + + +.SH DESCRIPTION +Display labels in a GitHub repository. + +.PP +When using the \fB--search\fR flag results are sorted by best match of the query. +This behavior cannot be configured with the \fB--order\fR or \fB--sort\fR flags. + + +.SH OPTIONS +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB<fields>\fR +Output JSON with the specified fields + +.TP +\fB-L\fR, \fB--limit\fR \fB<int> (default 30)\fR +Maximum number of labels to fetch + +.TP +\fB--order\fR \fB<string> (default "asc")\fR +Order of labels returned: {asc|desc} + +.TP +\fB-S\fR, \fB--search\fR \fB<string>\fR +Search label names and descriptions + +.TP +\fB--sort\fR \fB<string> (default "created")\fR +Sort fetched labels: {created|name} + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB-w\fR, \fB--web\fR +List labels 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 label ls + + +.SH JSON FIELDS +\fBcolor\fR, \fBcreatedAt\fR, \fBdescription\fR, \fBid\fR, \fBisDefault\fR, \fBname\fR, \fBupdatedAt\fR, \fBurl\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 EXAMPLE +.EX +# Sort labels by name +$ gh label list --sort name + +# Find labels with "bug" in the name or description +$ gh label list --search bug + +.EE + + +.SH SEE ALSO +\fBgh-label(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-label.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-label.1 new file mode 100644 index 00000000..eb5d9677 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-label.1 @@ -0,0 +1,61 @@ +.nh +.TH "GH-LABEL" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-label - Manage labels + + +.SH SYNOPSIS +\fBgh label <command> [flags]\fR + + +.SH DESCRIPTION +Work with GitHub labels. + + +.SH AVAILABLE COMMANDS +.TP +\fBgh-label-clone(1)\fR +Clones labels from one repository to another + +.TP +\fBgh-label-create(1)\fR +Create a new label + +.TP +\fBgh-label-delete(1)\fR +Delete a label from a repository + +.TP +\fBgh-label-edit(1)\fR +Edit a label + +.TP +\fBgh-label-list(1)\fR +List labels in a 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(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-org-list.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-org-list.1 new file mode 100644 index 00000000..435a9c7d --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-org-list.1 @@ -0,0 +1,50 @@ +.nh +.TH "GH-ORG-LIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-org-list - List organizations for the authenticated user. + + +.SH SYNOPSIS +\fBgh org list [flags]\fR + + +.SH OPTIONS +.TP +\fB-L\fR, \fB--limit\fR \fB<int> (default 30)\fR +Maximum number of organizations to list + + +.SH ALIASES +gh org 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 EXAMPLE +.EX +# List the first 30 organizations +$ gh org list + +# List more organizations +$ gh org list --limit 100 + +.EE + + +.SH SEE ALSO +\fBgh-org(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-org.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-org.1 new file mode 100644 index 00000000..5e8871bd --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-org.1 @@ -0,0 +1,46 @@ +.nh +.TH "GH-ORG" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-org - Manage organizations + + +.SH SYNOPSIS +\fBgh org <command> [flags]\fR + + +.SH DESCRIPTION +Work with GitHub organizations. + + +.SH GENERAL COMMANDS +.TP +\fBgh-org-list(1)\fR +List organizations for the authenticated user. + + +.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 +$ gh org list + +.EE + + +.SH SEE ALSO +\fBgh(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-checkout.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-checkout.1 new file mode 100644 index 00000000..d27cb307 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-checkout.1 @@ -0,0 +1,66 @@ +.nh +.TH "GH-PR-CHECKOUT" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-pr-checkout - Check out a pull request in git + + +.SH SYNOPSIS +\fBgh pr checkout [<number> | <url> | <branch>] [flags]\fR + + +.SH OPTIONS +.TP +\fB-b\fR, \fB--branch\fR \fB<string>\fR +Local branch name to use (default [the name of the head branch]) + +.TP +\fB--detach\fR +Checkout PR with a detached HEAD + +.TP +\fB-f\fR, \fB--force\fR +Reset the existing local branch to the latest state of the pull request + +.TP +\fB--recurse-submodules\fR +Update all submodules after checkout + + +.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 +# Interactively select a PR from the 10 most recent to check out +$ gh pr checkout + +# Checkout a specific PR +$ gh pr checkout 32 +$ gh pr checkout https://github.com/OWNER/REPO/pull/32 +$ gh pr checkout feature + +.EE + + +.SH SEE ALSO +\fBgh-pr(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-checks.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-checks.1 new file mode 100644 index 00000000..1cbedc44 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-checks.1 @@ -0,0 +1,89 @@ +.nh +.TH "GH-PR-CHECKS" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-pr-checks - Show CI status for a single pull request + + +.SH SYNOPSIS +\fBgh pr checks [<number> | <url> | <branch>] [flags]\fR + + +.SH DESCRIPTION +Show CI status for a single pull request. + +.PP +Without an argument, the pull request that belongs to the current branch +is selected. + +.PP +When the \fB--json\fR flag is used, it includes a \fBbucket\fR field, which categorizes +the \fBstate\fR field into \fBpass\fR, \fBfail\fR, \fBpending\fR, \fBskipping\fR, or \fBcancel\fR\&. + +.PP +Additional exit codes: + 8: Checks pending + + +.SH OPTIONS +.TP +\fB--fail-fast\fR +Exit watch mode on first check failure + +.TP +\fB-i\fR, \fB--interval\fR \fB<--watch> (default 10)\fR +Refresh interval in seconds when using --watch flag + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB<fields>\fR +Output JSON with the specified fields + +.TP +\fB--required\fR +Only show checks that are required + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB--watch\fR +Watch checks until they finish + +.TP +\fB-w\fR, \fB--web\fR +Open the web browser to show details about checks + + +.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 +\fBbucket\fR, \fBcompletedAt\fR, \fBdescription\fR, \fBevent\fR, \fBlink\fR, \fBname\fR, \fBstartedAt\fR, \fBstate\fR, \fBworkflow\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-pr(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-close.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-close.1 new file mode 100644 index 00000000..ffa4f6ce --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-close.1 @@ -0,0 +1,45 @@ +.nh +.TH "GH-PR-CLOSE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-pr-close - Close a pull request + + +.SH SYNOPSIS +\fBgh pr close {<number> | <url> | <branch>} [flags]\fR + + +.SH OPTIONS +.TP +\fB-c\fR, \fB--comment\fR \fB<string>\fR +Leave a closing comment + +.TP +\fB-d\fR, \fB--delete-branch\fR +Delete the local and remote branch after close + + +.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-pr(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-comment.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-comment.1 new file mode 100644 index 00000000..45e5033a --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-comment.1 @@ -0,0 +1,84 @@ +.nh +.TH "GH-PR-COMMENT" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-pr-comment - Add a comment to a pull request + + +.SH SYNOPSIS +\fBgh pr comment [<number> | <url> | <branch>] [flags]\fR + + +.SH DESCRIPTION +Add a comment to a GitHub pull request. + +.PP +Without the body text supplied through flags, the command will interactively +prompt for the comment text. + + +.SH OPTIONS +.TP +\fB-b\fR, \fB--body\fR \fB<text>\fR +The comment body text + +.TP +\fB-F\fR, \fB--body-file\fR \fB<file>\fR +Read body text from file (use "-" to read from standard input) + +.TP +\fB--create-if-none\fR +Create a new comment if no comments are found. Can be used only with --edit-last + +.TP +\fB--delete-last\fR +Delete the last comment of the current user + +.TP +\fB--edit-last\fR +Edit the last comment of the current user + +.TP +\fB-e\fR, \fB--editor\fR +Skip prompts and open the text editor to write the body in + +.TP +\fB-w\fR, \fB--web\fR +Open the web browser to write the comment + +.TP +\fB--yes\fR +Skip the delete confirmation prompt when --delete-last is provided + + +.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 +$ gh pr comment 13 --body "Hi from GitHub CLI" + +.EE + + +.SH SEE ALSO +\fBgh-pr(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-create.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-create.1 new file mode 100644 index 00000000..14d985c0 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-create.1 @@ -0,0 +1,176 @@ +.nh +.TH "GH-PR-CREATE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-pr-create - Create a pull request + + +.SH SYNOPSIS +\fBgh pr create [flags]\fR + + +.SH DESCRIPTION +Create a pull request on GitHub. + +.PP +Upon success, the URL of the created pull request will be printed. + +.PP +When the current branch isn't fully pushed to a git remote, a prompt will ask where +to push the branch and offer an option to fork the base repository. Use \fB--head\fR to +explicitly skip any forking or pushing behavior. + +.PP +\fB--head\fR supports \fB<user>:<branch>\fR syntax to select a head repo owned by \fB<user>\fR\&. +Using an organization as the \fB<user>\fR is currently not supported. +For more information, see +\[la]https://github.com/cli/cli/issues/10093\[ra] + +.PP +A prompt will also ask for the title and the body of the pull request. Use \fB--title\fR and +\fB--body\fR to skip this, or use \fB--fill\fR to autofill these values from git commits. +It's important to notice that if the \fB--title\fR and/or \fB--body\fR are also provided +alongside \fB--fill\fR, the values specified by \fB--title\fR and/or \fB--body\fR will +take precedence and overwrite any autofilled content. + +.PP +The base branch for the created PR can be specified using the \fB--base\fR flag. If not provided, +the value of \fBgh-merge-base\fR git branch config will be used. If not configured, the repository's +default branch will be used. Run \fBgit config branch.{current}.gh-merge-base {base}\fR to configure +the current branch to use the specified merge base. + +.PP +Link an issue to the pull request by referencing the issue in the body of the pull +request. If the body text mentions \fBFixes #123\fR or \fBCloses #123\fR, the referenced issue +will automatically get closed when the pull request gets merged. + +.PP +By default, users with write access to the base repository can push new commits to the +head branch of the pull request. Disable this with \fB--no-maintainer-edit\fR\&. + +.PP +Adding a pull request to projects requires authorization with the \fBproject\fR scope. +To authorize, run \fBgh auth refresh -s project\fR\&. + + +.SH OPTIONS +.TP +\fB-a\fR, \fB--assignee\fR \fB<login>\fR +Assign people by their login. Use "@me" to self-assign. + +.TP +\fB-B\fR, \fB--base\fR \fB<branch>\fR +The branch into which you want your code merged + +.TP +\fB-b\fR, \fB--body\fR \fB<string>\fR +Body for the pull request + +.TP +\fB-F\fR, \fB--body-file\fR \fB<file>\fR +Read body text from file (use "-" to read from standard input) + +.TP +\fB-d\fR, \fB--draft\fR +Mark pull request as a draft + +.TP +\fB--dry-run\fR +Print details instead of creating the PR. May still push git changes. + +.TP +\fB-e\fR, \fB--editor\fR +Skip prompts and open the text editor to write the title and body in. The first line is the title and the remaining text is the body. + +.TP +\fB-f\fR, \fB--fill\fR +Use commit info for title and body + +.TP +\fB--fill-first\fR +Use first commit info for title and body + +.TP +\fB--fill-verbose\fR +Use commits msg+body for description + +.TP +\fB-H\fR, \fB--head\fR \fB<branch>\fR +The branch that contains commits for your pull request (default [current branch]) + +.TP +\fB-l\fR, \fB--label\fR \fB<name>\fR +Add labels by name + +.TP +\fB-m\fR, \fB--milestone\fR \fB<name>\fR +Add the pull request to a milestone by name + +.TP +\fB--no-maintainer-edit\fR +Disable maintainer's ability to modify pull request + +.TP +\fB-p\fR, \fB--project\fR \fB<title>\fR +Add the pull request to projects by title + +.TP +\fB--recover\fR \fB<string>\fR +Recover input from a failed run of create + +.TP +\fB-r\fR, \fB--reviewer\fR \fB<handle>\fR +Request reviews from people or teams by their handle + +.TP +\fB-T\fR, \fB--template\fR \fB<file>\fR +Template file to use as starting body text + +.TP +\fB-t\fR, \fB--title\fR \fB<string>\fR +Title for the pull request + +.TP +\fB-w\fR, \fB--web\fR +Open the web browser to create a pull request + + +.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 pr 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 +$ gh pr create --title "The bug is fixed" --body "Everything works again" +$ gh pr create --reviewer monalisa,hubot --reviewer myorg/team-name +$ gh pr create --project "Roadmap" +$ gh pr create --base develop --head monalisa:feature +$ gh pr create --template "pull_request_template.md" + +.EE + + +.SH SEE ALSO +\fBgh-pr(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-diff.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-diff.1 new file mode 100644 index 00000000..e0135795 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-diff.1 @@ -0,0 +1,64 @@ +.nh +.TH "GH-PR-DIFF" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-pr-diff - View changes in a pull request + + +.SH SYNOPSIS +\fBgh pr diff [<number> | <url> | <branch>] [flags]\fR + + +.SH DESCRIPTION +View changes in a pull request. + +.PP +Without an argument, the pull request that belongs to the current branch +is selected. + +.PP +With \fB--web\fR flag, open the pull request diff in a web browser instead. + + +.SH OPTIONS +.TP +\fB--color\fR \fB<string> (default "auto")\fR +Use color in diff output: {always|never|auto} + +.TP +\fB--name-only\fR +Display only names of changed files + +.TP +\fB--patch\fR +Display diff in patch format + +.TP +\fB-w\fR, \fB--web\fR +Open the pull request diff in the 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 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-pr(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-edit.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-edit.1 new file mode 100644 index 00000000..52f6a4e2 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-edit.1 @@ -0,0 +1,129 @@ +.nh +.TH "GH-PR-EDIT" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-pr-edit - Edit a pull request + + +.SH SYNOPSIS +\fBgh pr edit [<number> | <url> | <branch>] [flags]\fR + + +.SH DESCRIPTION +Edit a pull request. + +.PP +Without an argument, the pull request that belongs to the current branch +is selected. + +.PP +Editing a pull request's projects requires authorization with the \fBproject\fR scope. +To authorize, run \fBgh auth refresh -s project\fR\&. + +.PP +The \fB--add-assignee\fR and \fB--remove-assignee\fR flags both support +the following special values: +- \fB@me\fR: assign or unassign yourself +- \fB@copilot\fR: assign or unassign Copilot (not supported on GitHub Enterprise Server) + +.PP +The \fB--add-reviewer\fR and \fB--remove-reviewer\fR flags do not support +these special values. + + +.SH OPTIONS +.TP +\fB--add-assignee\fR \fB<login>\fR +Add assigned users by their login. Use "@me" to assign yourself, or "@copilot" to assign Copilot. + +.TP +\fB--add-label\fR \fB<name>\fR +Add labels by name + +.TP +\fB--add-project\fR \fB<title>\fR +Add the pull request to projects by title + +.TP +\fB--add-reviewer\fR \fB<login>\fR +Add reviewers by their login. + +.TP +\fB-B\fR, \fB--base\fR \fB<branch>\fR +Change the base branch for this pull request + +.TP +\fB-b\fR, \fB--body\fR \fB<string>\fR +Set the new body. + +.TP +\fB-F\fR, \fB--body-file\fR \fB<file>\fR +Read body text from file (use "-" to read from standard input) + +.TP +\fB-m\fR, \fB--milestone\fR \fB<name>\fR +Edit the milestone the pull request belongs to by name + +.TP +\fB--remove-assignee\fR \fB<login>\fR +Remove assigned users by their login. Use "@me" to unassign yourself, or "@copilot" to unassign Copilot. + +.TP +\fB--remove-label\fR \fB<name>\fR +Remove labels by name + +.TP +\fB--remove-milestone\fR +Remove the milestone association from the pull request + +.TP +\fB--remove-project\fR \fB<title>\fR +Remove the pull request from projects by title + +.TP +\fB--remove-reviewer\fR \fB<login>\fR +Remove reviewers by their login. + +.TP +\fB-t\fR, \fB--title\fR \fB<string>\fR +Set the new title. + + +.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 +$ gh pr edit 23 --title "I found a bug" --body "Nothing works" +$ gh pr edit 23 --add-label "bug,help wanted" --remove-label "core" +$ gh pr edit 23 --add-reviewer monalisa,hubot --remove-reviewer myorg/team-name +$ gh pr edit 23 --add-assignee "@me" --remove-assignee monalisa,hubot +$ gh pr edit 23 --add-assignee "@copilot" +$ gh pr edit 23 --add-project "Roadmap" --remove-project v1,v2 +$ gh pr edit 23 --milestone "Version 1" +$ gh pr edit 23 --remove-milestone + +.EE + + +.SH SEE ALSO +\fBgh-pr(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-list.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-list.1 new file mode 100644 index 00000000..14e17896 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-list.1 @@ -0,0 +1,130 @@ +.nh +.TH "GH-PR-LIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-pr-list - List pull requests in a repository + + +.SH SYNOPSIS +\fBgh pr list [flags]\fR + + +.SH DESCRIPTION +List pull requests in a GitHub repository. By default, this only lists open PRs. + +.PP +The search query syntax is documented here: + +\[la]https://docs.github.com/en/search\-github/searching\-on\-github/searching\-issues\-and\-pull\-requests\[ra] + + +.SH OPTIONS +.TP +\fB--app\fR \fB<string>\fR +Filter by GitHub App author + +.TP +\fB-a\fR, \fB--assignee\fR \fB<string>\fR +Filter by assignee + +.TP +\fB-A\fR, \fB--author\fR \fB<string>\fR +Filter by author + +.TP +\fB-B\fR, \fB--base\fR \fB<string>\fR +Filter by base branch + +.TP +\fB-d\fR, \fB--draft\fR +Filter by draft state + +.TP +\fB-H\fR, \fB--head\fR \fB<string>\fR +Filter by head branch (":" syntax not supported) + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB<fields>\fR +Output JSON with the specified fields + +.TP +\fB-l\fR, \fB--label\fR \fB<strings>\fR +Filter by label + +.TP +\fB-L\fR, \fB--limit\fR \fB<int> (default 30)\fR +Maximum number of items to fetch + +.TP +\fB-S\fR, \fB--search\fR \fB<query>\fR +Search pull requests with query + +.TP +\fB-s\fR, \fB--state\fR \fB<string> (default "open")\fR +Filter by state: {open|closed|merged|all} + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB-w\fR, \fB--web\fR +List pull requests 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 pr ls + + +.SH JSON FIELDS +\fBadditions\fR, \fBassignees\fR, \fBauthor\fR, \fBautoMergeRequest\fR, \fBbaseRefName\fR, \fBbaseRefOid\fR, \fBbody\fR, \fBchangedFiles\fR, \fBclosed\fR, \fBclosedAt\fR, \fBclosingIssuesReferences\fR, \fBcomments\fR, \fBcommits\fR, \fBcreatedAt\fR, \fBdeletions\fR, \fBfiles\fR, \fBfullDatabaseId\fR, \fBheadRefName\fR, \fBheadRefOid\fR, \fBheadRepository\fR, \fBheadRepositoryOwner\fR, \fBid\fR, \fBisCrossRepository\fR, \fBisDraft\fR, \fBlabels\fR, \fBlatestReviews\fR, \fBmaintainerCanModify\fR, \fBmergeCommit\fR, \fBmergeStateStatus\fR, \fBmergeable\fR, \fBmergedAt\fR, \fBmergedBy\fR, \fBmilestone\fR, \fBnumber\fR, \fBpotentialMergeCommit\fR, \fBprojectCards\fR, \fBprojectItems\fR, \fBreactionGroups\fR, \fBreviewDecision\fR, \fBreviewRequests\fR, \fBreviews\fR, \fBstate\fR, \fBstatusCheckRollup\fR, \fBtitle\fR, \fBupdatedAt\fR, \fBurl\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 EXAMPLE +.EX +# List PRs authored by you +$ gh pr list --author "@me" + +# List PRs with a specific head branch name +$ gh pr list --head "typo" + +# List only PRs with all of the given labels +$ gh pr list --label bug --label "priority 1" + +# Filter PRs using search syntax +$ gh pr list --search "status:success review:required" + +# Find a PR that introduced a given commit +$ gh pr list --search "<SHA>" --state merged + +.EE + + +.SH SEE ALSO +\fBgh-pr(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-lock.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-lock.1 new file mode 100644 index 00000000..b918b35e --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-lock.1 @@ -0,0 +1,41 @@ +.nh +.TH "GH-PR-LOCK" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-pr-lock - Lock pull request conversation + + +.SH SYNOPSIS +\fBgh pr lock {<number> | <url>} [flags]\fR + + +.SH OPTIONS +.TP +\fB-r\fR, \fB--reason\fR \fB<string>\fR +Optional reason for locking conversation (off_topic, resolved, spam, too_heated). + + +.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-pr(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-merge.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-merge.1 new file mode 100644 index 00000000..b1273daf --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-merge.1 @@ -0,0 +1,99 @@ +.nh +.TH "GH-PR-MERGE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-pr-merge - Merge a pull request + + +.SH SYNOPSIS +\fBgh pr merge [<number> | <url> | <branch>] [flags]\fR + + +.SH DESCRIPTION +Merge a pull request on GitHub. + +.PP +Without an argument, the pull request that belongs to the current branch +is selected. + +.PP +When targeting a branch that requires a merge queue, no merge strategy is required. +If required checks have not yet passed, auto-merge will be enabled. +If required checks have passed, the pull request will be added to the merge queue. +To bypass a merge queue and merge directly, pass the \fB--admin\fR flag. + + +.SH OPTIONS +.TP +\fB--admin\fR +Use administrator privileges to merge a pull request that does not meet requirements + +.TP +\fB-A\fR, \fB--author-email\fR \fB<text>\fR +Email text for merge commit author + +.TP +\fB--auto\fR +Automatically merge only after necessary requirements are met + +.TP +\fB-b\fR, \fB--body\fR \fB<text>\fR +Body text for the merge commit + +.TP +\fB-F\fR, \fB--body-file\fR \fB<file>\fR +Read body text from file (use "-" to read from standard input) + +.TP +\fB-d\fR, \fB--delete-branch\fR +Delete the local and remote branch after merge + +.TP +\fB--disable-auto\fR +Disable auto-merge for this pull request + +.TP +\fB--match-head-commit\fR \fB<SHA>\fR +Commit SHA that the pull request head must match to allow merge + +.TP +\fB-m\fR, \fB--merge\fR +Merge the commits with the base branch + +.TP +\fB-r\fR, \fB--rebase\fR +Rebase the commits onto the base branch + +.TP +\fB-s\fR, \fB--squash\fR +Squash the commits into one commit and merge it into the base branch + +.TP +\fB-t\fR, \fB--subject\fR \fB<text>\fR +Subject text for the merge commit + + +.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-pr(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-ready.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-ready.1 new file mode 100644 index 00000000..f5c23f27 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-ready.1 @@ -0,0 +1,52 @@ +.nh +.TH "GH-PR-READY" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-pr-ready - Mark a pull request as ready for review + + +.SH SYNOPSIS +\fBgh pr ready [<number> | <url> | <branch>] [flags]\fR + + +.SH DESCRIPTION +Mark a pull request as ready for review. + +.PP +Without an argument, the pull request that belongs to the current branch +is marked as ready. + +.PP +If supported by your plan, convert to draft with \fB--undo\fR + + +.SH OPTIONS +.TP +\fB--undo\fR +Convert a pull request to "draft" + + +.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-pr(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-reopen.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-reopen.1 new file mode 100644 index 00000000..7371b08e --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-reopen.1 @@ -0,0 +1,41 @@ +.nh +.TH "GH-PR-REOPEN" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-pr-reopen - Reopen a pull request + + +.SH SYNOPSIS +\fBgh pr reopen {<number> | <url> | <branch>} [flags]\fR + + +.SH OPTIONS +.TP +\fB-c\fR, \fB--comment\fR \fB<string>\fR +Add a reopening comment + + +.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-pr(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-review.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-review.1 new file mode 100644 index 00000000..4b00917a --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-review.1 @@ -0,0 +1,81 @@ +.nh +.TH "GH-PR-REVIEW" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-pr-review - Add a review to a pull request + + +.SH SYNOPSIS +\fBgh pr review [<number> | <url> | <branch>] [flags]\fR + + +.SH DESCRIPTION +Add a review to a pull request. + +.PP +Without an argument, the pull request that belongs to the current branch is reviewed. + + +.SH OPTIONS +.TP +\fB-a\fR, \fB--approve\fR +Approve pull request + +.TP +\fB-b\fR, \fB--body\fR \fB<string>\fR +Specify the body of a review + +.TP +\fB-F\fR, \fB--body-file\fR \fB<file>\fR +Read body text from file (use "-" to read from standard input) + +.TP +\fB-c\fR, \fB--comment\fR +Comment on a pull request + +.TP +\fB-r\fR, \fB--request-changes\fR +Request changes on a pull request + + +.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 +# Approve the pull request of the current branch +$ gh pr review --approve + +# Leave a review comment for the current branch +$ gh pr review --comment -b "interesting" + +# Add a review for a specific pull request +$ gh pr review 123 + +# Request changes on a specific pull request +$ gh pr review 123 -r -b "needs more ASCII art" + +.EE + + +.SH SEE ALSO +\fBgh-pr(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-status.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-status.1 new file mode 100644 index 00000000..da7974c8 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-status.1 @@ -0,0 +1,68 @@ +.nh +.TH "GH-PR-STATUS" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-pr-status - Show status of relevant pull requests + + +.SH SYNOPSIS +\fBgh pr status [flags]\fR + + +.SH DESCRIPTION +Show status of relevant pull requests. + +.PP +The status shows a summary of pull requests that includes information such as +pull request number, title, CI checks, reviews, etc. + +.PP +To see more details of CI checks, run \fBgh pr checks\fR\&. + + +.SH OPTIONS +.TP +\fB-c\fR, \fB--conflict-status\fR +Display the merge conflict status of each pull request + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB<fields>\fR +Output JSON with the specified fields + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\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 +\fBadditions\fR, \fBassignees\fR, \fBauthor\fR, \fBautoMergeRequest\fR, \fBbaseRefName\fR, \fBbaseRefOid\fR, \fBbody\fR, \fBchangedFiles\fR, \fBclosed\fR, \fBclosedAt\fR, \fBclosingIssuesReferences\fR, \fBcomments\fR, \fBcommits\fR, \fBcreatedAt\fR, \fBdeletions\fR, \fBfiles\fR, \fBfullDatabaseId\fR, \fBheadRefName\fR, \fBheadRefOid\fR, \fBheadRepository\fR, \fBheadRepositoryOwner\fR, \fBid\fR, \fBisCrossRepository\fR, \fBisDraft\fR, \fBlabels\fR, \fBlatestReviews\fR, \fBmaintainerCanModify\fR, \fBmergeCommit\fR, \fBmergeStateStatus\fR, \fBmergeable\fR, \fBmergedAt\fR, \fBmergedBy\fR, \fBmilestone\fR, \fBnumber\fR, \fBpotentialMergeCommit\fR, \fBprojectCards\fR, \fBprojectItems\fR, \fBreactionGroups\fR, \fBreviewDecision\fR, \fBreviewRequests\fR, \fBreviews\fR, \fBstate\fR, \fBstatusCheckRollup\fR, \fBtitle\fR, \fBupdatedAt\fR, \fBurl\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-pr(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-unlock.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-unlock.1 new file mode 100644 index 00000000..f6ce9d3e --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-unlock.1 @@ -0,0 +1,35 @@ +.nh +.TH "GH-PR-UNLOCK" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-pr-unlock - Unlock pull request conversation + + +.SH SYNOPSIS +\fBgh pr unlock {<number> | <url>} [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-pr(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-update-branch.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-update-branch.1 new file mode 100644 index 00000000..41e4a046 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-update-branch.1 @@ -0,0 +1,62 @@ +.nh +.TH "GH-PR-UPDATE-BRANCH" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-pr-update-branch - Update a pull request branch + + +.SH SYNOPSIS +\fBgh pr update-branch [<number> | <url> | <branch>] [flags]\fR + + +.SH DESCRIPTION +Update a pull request branch with latest changes of the base branch. + +.PP +Without an argument, the pull request that belongs to the current branch is selected. + +.PP +The default behavior is to update with a merge commit (i.e., merging the base branch +into the PR's branch). To reconcile the changes with rebasing on top of the base +branch, the \fB--rebase\fR option should be provided. + + +.SH OPTIONS +.TP +\fB--rebase\fR +Update PR branch by rebasing on top of latest base branch + + +.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 +$ gh pr update-branch 23 +$ gh pr update-branch 23 --rebase +$ gh pr update-branch 23 --repo owner/repo + +.EE + + +.SH SEE ALSO +\fBgh-pr(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-view.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-view.1 new file mode 100644 index 00000000..69595a65 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr-view.1 @@ -0,0 +1,72 @@ +.nh +.TH "GH-PR-VIEW" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-pr-view - View a pull request + + +.SH SYNOPSIS +\fBgh pr view [<number> | <url> | <branch>] [flags]\fR + + +.SH DESCRIPTION +Display the title, body, and other information about a pull request. + +.PP +Without an argument, the pull request that belongs to the current branch +is displayed. + +.PP +With \fB--web\fR flag, open the pull request in a web browser instead. + + +.SH OPTIONS +.TP +\fB-c\fR, \fB--comments\fR +View pull request comments + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB<fields>\fR +Output JSON with the specified fields + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB-w\fR, \fB--web\fR +Open a pull request in the 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 JSON FIELDS +\fBadditions\fR, \fBassignees\fR, \fBauthor\fR, \fBautoMergeRequest\fR, \fBbaseRefName\fR, \fBbaseRefOid\fR, \fBbody\fR, \fBchangedFiles\fR, \fBclosed\fR, \fBclosedAt\fR, \fBclosingIssuesReferences\fR, \fBcomments\fR, \fBcommits\fR, \fBcreatedAt\fR, \fBdeletions\fR, \fBfiles\fR, \fBfullDatabaseId\fR, \fBheadRefName\fR, \fBheadRefOid\fR, \fBheadRepository\fR, \fBheadRepositoryOwner\fR, \fBid\fR, \fBisCrossRepository\fR, \fBisDraft\fR, \fBlabels\fR, \fBlatestReviews\fR, \fBmaintainerCanModify\fR, \fBmergeCommit\fR, \fBmergeStateStatus\fR, \fBmergeable\fR, \fBmergedAt\fR, \fBmergedBy\fR, \fBmilestone\fR, \fBnumber\fR, \fBpotentialMergeCommit\fR, \fBprojectCards\fR, \fBprojectItems\fR, \fBreactionGroups\fR, \fBreviewDecision\fR, \fBreviewRequests\fR, \fBreviews\fR, \fBstate\fR, \fBstatusCheckRollup\fR, \fBtitle\fR, \fBupdatedAt\fR, \fBurl\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-pr(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr.1 new file mode 100644 index 00000000..b9336353 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-pr.1 @@ -0,0 +1,120 @@ +.nh +.TH "GH-PR" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-pr - Manage pull requests + + +.SH SYNOPSIS +\fBgh pr <command> [flags]\fR + + +.SH DESCRIPTION +Work with GitHub pull requests. + + +.SH GENERAL COMMANDS +.TP +\fBgh-pr-create(1)\fR +Create a pull request + +.TP +\fBgh-pr-list(1)\fR +List pull requests in a repository + +.TP +\fBgh-pr-status(1)\fR +Show status of relevant pull requests + + +.SH TARGETED COMMANDS +.TP +\fBgh-pr-checkout(1)\fR +Check out a pull request in git + +.TP +\fBgh-pr-checks(1)\fR +Show CI status for a single pull request + +.TP +\fBgh-pr-close(1)\fR +Close a pull request + +.TP +\fBgh-pr-comment(1)\fR +Add a comment to a pull request + +.TP +\fBgh-pr-diff(1)\fR +View changes in a pull request + +.TP +\fBgh-pr-edit(1)\fR +Edit a pull request + +.TP +\fBgh-pr-lock(1)\fR +Lock pull request conversation + +.TP +\fBgh-pr-merge(1)\fR +Merge a pull request + +.TP +\fBgh-pr-ready(1)\fR +Mark a pull request as ready for review + +.TP +\fBgh-pr-reopen(1)\fR +Reopen a pull request + +.TP +\fBgh-pr-review(1)\fR +Add a review to a pull request + +.TP +\fBgh-pr-unlock(1)\fR +Unlock pull request conversation + +.TP +\fBgh-pr-update-branch(1)\fR +Update a pull request branch + +.TP +\fBgh-pr-view(1)\fR +View a pull request + + +.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 EXAMPLE +.EX +$ gh pr checkout 353 +$ gh pr create --fill +$ gh pr view --web + +.EE + + +.SH SEE ALSO +\fBgh(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-preview-prompter.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-preview-prompter.1 new file mode 100644 index 00000000..8c1e8ffe --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-preview-prompter.1 @@ -0,0 +1,46 @@ +.nh +.TH "GH-PREVIEW-PROMPTER" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-preview-prompter - Execute a test program to preview the prompter + + +.SH SYNOPSIS +\fBgh preview prompter [prompt type] [flags]\fR + + +.SH DESCRIPTION +Execute a test program to preview the prompter. +Without an argument, all prompts will be run. + +.PP +Available prompt types: +- select +- multi-select +- input +- password +- confirm +- auth-token +- confirm-deletion +- input-hostname +- markdown-editor + + +.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-preview(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-preview.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-preview.1 new file mode 100644 index 00000000..d85ef2e8 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-preview.1 @@ -0,0 +1,40 @@ +.nh +.TH "GH-PREVIEW" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-preview - Execute previews for gh features + + +.SH SYNOPSIS +\fBgh preview <command> [flags]\fR + + +.SH DESCRIPTION +Preview commands are for testing, demonstrative, and development purposes only. +They should be considered unstable and can change at any time. + + +.SH AVAILABLE COMMANDS +.TP +\fBgh-preview-prompter(1)\fR +Execute a test program to preview the prompter + + +.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/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-close.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-close.1 new file mode 100644 index 00000000..307a0e7a --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-close.1 @@ -0,0 +1,62 @@ +.nh +.TH "GH-PROJECT-CLOSE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-project-close - Close a project + + +.SH SYNOPSIS +\fBgh project close [<number>] [flags]\fR + + +.SH OPTIONS +.TP +\fB--format\fR \fB<string>\fR +Output format: {json} + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--owner\fR \fB<string>\fR +Login of the owner. Use "@me" for the current user. + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB--undo\fR +Reopen a closed project + + +.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 +# Close project "1" owned by monalisa +$ gh project close 1 --owner monalisa + +# Reopen closed project "1" owned by github +$ gh project close 1 --owner github --undo + +.EE + + +.SH SEE ALSO +\fBgh-project(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-copy.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-copy.1 new file mode 100644 index 00000000..3bb18f5f --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-copy.1 @@ -0,0 +1,67 @@ +.nh +.TH "GH-PROJECT-COPY" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-project-copy - Copy a project + + +.SH SYNOPSIS +\fBgh project copy [<number>] [flags]\fR + + +.SH OPTIONS +.TP +\fB--drafts\fR +Include draft issues when copying + +.TP +\fB--format\fR \fB<string>\fR +Output format: {json} + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--source-owner\fR \fB<string>\fR +Login of the source owner. Use "@me" for the current user. + +.TP +\fB--target-owner\fR \fB<string>\fR +Login of the target owner. Use "@me" for the current user. + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB--title\fR \fB<string>\fR +Title for the new project + + +.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 +# Copy project "1" owned by monalisa to github +$ gh project copy 1 --source-owner monalisa --target-owner github --title "a new project" + +.EE + + +.SH SEE ALSO +\fBgh-project(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-create.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-create.1 new file mode 100644 index 00000000..36782ee7 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-create.1 @@ -0,0 +1,59 @@ +.nh +.TH "GH-PROJECT-CREATE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-project-create - Create a project + + +.SH SYNOPSIS +\fBgh project create [flags]\fR + + +.SH OPTIONS +.TP +\fB--format\fR \fB<string>\fR +Output format: {json} + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--owner\fR \fB<string>\fR +Login of the owner. Use "@me" for the current user. + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB--title\fR \fB<string>\fR +Title for the project + + +.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 new project owned by login monalisa +$ gh project create --owner monalisa --title "a new project" + +.EE + + +.SH SEE ALSO +\fBgh-project(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-delete.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-delete.1 new file mode 100644 index 00000000..23d67b01 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-delete.1 @@ -0,0 +1,55 @@ +.nh +.TH "GH-PROJECT-DELETE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-project-delete - Delete a project + + +.SH SYNOPSIS +\fBgh project delete [<number>] [flags]\fR + + +.SH OPTIONS +.TP +\fB--format\fR \fB<string>\fR +Output format: {json} + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--owner\fR \fB<string>\fR +Login of the owner. Use "@me" for the current user. + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + + +.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 +# Delete the current user's project "1" +$ gh project delete 1 --owner "@me" + +.EE + + +.SH SEE ALSO +\fBgh-project(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-edit.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-edit.1 new file mode 100644 index 00000000..e660c3e3 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-edit.1 @@ -0,0 +1,71 @@ +.nh +.TH "GH-PROJECT-EDIT" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-project-edit - Edit a project + + +.SH SYNOPSIS +\fBgh project edit [<number>] [flags]\fR + + +.SH OPTIONS +.TP +\fB-d\fR, \fB--description\fR \fB<string>\fR +New description of the project + +.TP +\fB--format\fR \fB<string>\fR +Output format: {json} + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--owner\fR \fB<string>\fR +Login of the owner. Use "@me" for the current user. + +.TP +\fB--readme\fR \fB<string>\fR +New readme for the project + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB--title\fR \fB<string>\fR +New title for the project + +.TP +\fB--visibility\fR \fB<string>\fR +Change project visibility: {PUBLIC|PRIVATE} + + +.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 +# Edit the title of monalisa's project "1" +$ gh project edit 1 --owner monalisa --title "New title" + +.EE + + +.SH SEE ALSO +\fBgh-project(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-field-create.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-field-create.1 new file mode 100644 index 00000000..b0d2488f --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-field-create.1 @@ -0,0 +1,70 @@ +.nh +.TH "GH-PROJECT-FIELD-CREATE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-project-field-create - Create a field in a project + + +.SH SYNOPSIS +\fBgh project field-create [<number>] [flags]\fR + + +.SH OPTIONS +.TP +\fB--data-type\fR \fB<string>\fR +DataType of the new field.: {TEXT|SINGLE_SELECT|DATE|NUMBER} + +.TP +\fB--format\fR \fB<string>\fR +Output format: {json} + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--name\fR \fB<string>\fR +Name of the new field + +.TP +\fB--owner\fR \fB<string>\fR +Login of the owner. Use "@me" for the current user. + +.TP +\fB--single-select-options\fR \fB<strings>\fR +Options for SINGLE_SELECT data type + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + + +.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 field in the current user's project "1" +$ gh project field-create 1 --owner "@me" --name "new field" --data-type "text" + +# Create a field with three options to select from for owner monalisa +$ gh project field-create 1 --owner monalisa --name "new field" --data-type "SINGLE_SELECT" --single-select-options "one,two,three" + +.EE + + +.SH SEE ALSO +\fBgh-project(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-field-delete.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-field-delete.1 new file mode 100644 index 00000000..87ff76f2 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-field-delete.1 @@ -0,0 +1,47 @@ +.nh +.TH "GH-PROJECT-FIELD-DELETE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-project-field-delete - Delete a field in a project + + +.SH SYNOPSIS +\fBgh project field-delete [flags]\fR + + +.SH OPTIONS +.TP +\fB--format\fR \fB<string>\fR +Output format: {json} + +.TP +\fB--id\fR \fB<string>\fR +ID of the field to delete + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + + +.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-project(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-field-list.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-field-list.1 new file mode 100644 index 00000000..1a973f94 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-field-list.1 @@ -0,0 +1,59 @@ +.nh +.TH "GH-PROJECT-FIELD-LIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-project-field-list - List the fields in a project + + +.SH SYNOPSIS +\fBgh project field-list [<number>] [flags]\fR + + +.SH OPTIONS +.TP +\fB--format\fR \fB<string>\fR +Output format: {json} + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB-L\fR, \fB--limit\fR \fB<int> (default 30)\fR +Maximum number of fields to fetch + +.TP +\fB--owner\fR \fB<string>\fR +Login of the owner. Use "@me" for the current user. + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + + +.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 +# List fields in the current user's project "1" +$ gh project field-list 1 --owner "@me" + +.EE + + +.SH SEE ALSO +\fBgh-project(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-item-add.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-item-add.1 new file mode 100644 index 00000000..c5cd44ce --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-item-add.1 @@ -0,0 +1,59 @@ +.nh +.TH "GH-PROJECT-ITEM-ADD" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-project-item-add - Add a pull request or an issue to a project + + +.SH SYNOPSIS +\fBgh project item-add [<number>] [flags]\fR + + +.SH OPTIONS +.TP +\fB--format\fR \fB<string>\fR +Output format: {json} + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--owner\fR \fB<string>\fR +Login of the owner. Use "@me" for the current user. + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB--url\fR \fB<string>\fR +URL of the issue or pull request to add to the project + + +.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 +# Add an item to monalisa's project "1" +$ gh project item-add 1 --owner monalisa --url https://github.com/monalisa/myproject/issues/23 + +.EE + + +.SH SEE ALSO +\fBgh-project(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-item-archive.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-item-archive.1 new file mode 100644 index 00000000..77dde20b --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-item-archive.1 @@ -0,0 +1,63 @@ +.nh +.TH "GH-PROJECT-ITEM-ARCHIVE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-project-item-archive - Archive an item in a project + + +.SH SYNOPSIS +\fBgh project item-archive [<number>] [flags]\fR + + +.SH OPTIONS +.TP +\fB--format\fR \fB<string>\fR +Output format: {json} + +.TP +\fB--id\fR \fB<string>\fR +ID of the item to archive + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--owner\fR \fB<string>\fR +Login of the owner. Use "@me" for the current user. + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB--undo\fR +Unarchive an item + + +.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 +# Archive an item in the current user's project "1" +$ gh project item-archive 1 --owner "@me" --id <item-ID> + +.EE + + +.SH SEE ALSO +\fBgh-project(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-item-create.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-item-create.1 new file mode 100644 index 00000000..f1393a08 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-item-create.1 @@ -0,0 +1,63 @@ +.nh +.TH "GH-PROJECT-ITEM-CREATE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-project-item-create - Create a draft issue item in a project + + +.SH SYNOPSIS +\fBgh project item-create [<number>] [flags]\fR + + +.SH OPTIONS +.TP +\fB--body\fR \fB<string>\fR +Body for the draft issue + +.TP +\fB--format\fR \fB<string>\fR +Output format: {json} + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--owner\fR \fB<string>\fR +Login of the owner. Use "@me" for the current user. + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB--title\fR \fB<string>\fR +Title for the draft issue + + +.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 draft issue in the current user's project "1" +$ gh project item-create 1 --owner "@me" --title "new item" --body "new item body" + +.EE + + +.SH SEE ALSO +\fBgh-project(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-item-delete.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-item-delete.1 new file mode 100644 index 00000000..cd5c1b81 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-item-delete.1 @@ -0,0 +1,59 @@ +.nh +.TH "GH-PROJECT-ITEM-DELETE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-project-item-delete - Delete an item from a project by ID + + +.SH SYNOPSIS +\fBgh project item-delete [<number>] [flags]\fR + + +.SH OPTIONS +.TP +\fB--format\fR \fB<string>\fR +Output format: {json} + +.TP +\fB--id\fR \fB<string>\fR +ID of the item to delete + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--owner\fR \fB<string>\fR +Login of the owner. Use "@me" for the current user. + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + + +.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 +# Delete an item in the current user's project "1" +$ gh project item-delete 1 --owner "@me" --id <item-id> + +.EE + + +.SH SEE ALSO +\fBgh-project(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-item-edit.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-item-edit.1 new file mode 100644 index 00000000..4ef6528e --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-item-edit.1 @@ -0,0 +1,108 @@ +.nh +.TH "GH-PROJECT-ITEM-EDIT" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-project-item-edit - Edit an item in a project + + +.SH SYNOPSIS +\fBgh project item-edit [flags]\fR + + +.SH DESCRIPTION +Edit either a draft issue or a project item. Both usages require the ID of the item to edit. + +.PP +For non-draft issues, the ID of the project is also required, and only a single field value can be updated per invocation. + +.PP +Remove project item field value using \fB--clear\fR flag. + + +.SH OPTIONS +.TP +\fB--body\fR \fB<string>\fR +Body of the draft issue item + +.TP +\fB--clear\fR +Remove field value + +.TP +\fB--date\fR \fB<string>\fR +Date value for the field (YYYY-MM-DD) + +.TP +\fB--field-id\fR \fB<string>\fR +ID of the field to update + +.TP +\fB--format\fR \fB<string>\fR +Output format: {json} + +.TP +\fB--id\fR \fB<string>\fR +ID of the item to edit + +.TP +\fB--iteration-id\fR \fB<string>\fR +ID of the iteration value to set on the field + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--number\fR \fB<float> (default 0)\fR +Number value for the field + +.TP +\fB--project-id\fR \fB<string>\fR +ID of the project to which the field belongs to + +.TP +\fB--single-select-option-id\fR \fB<string>\fR +ID of the single select option value to set on the field + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB--text\fR \fB<string>\fR +Text value for the field + +.TP +\fB--title\fR \fB<string>\fR +Title of the draft issue item + + +.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 +# Edit an item's text field value +$ gh project item-edit --id <item-id> --field-id <field-id> --project-id <project-id> --text "new text" + +# Clear an item's field value +$ gh project item-edit --id <item-id> --field-id <field-id> --project-id <project-id> --clear + +.EE + + +.SH SEE ALSO +\fBgh-project(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-item-list.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-item-list.1 new file mode 100644 index 00000000..f6b3f96a --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-item-list.1 @@ -0,0 +1,59 @@ +.nh +.TH "GH-PROJECT-ITEM-LIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-project-item-list - List the items in a project + + +.SH SYNOPSIS +\fBgh project item-list [<number>] [flags]\fR + + +.SH OPTIONS +.TP +\fB--format\fR \fB<string>\fR +Output format: {json} + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB-L\fR, \fB--limit\fR \fB<int> (default 30)\fR +Maximum number of items to fetch + +.TP +\fB--owner\fR \fB<string>\fR +Login of the owner. Use "@me" for the current user. + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + + +.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 +# List the items in the current users's project "1" +$ gh project item-list 1 --owner "@me" + +.EE + + +.SH SEE ALSO +\fBgh-project(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-link.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-link.1 new file mode 100644 index 00000000..66065952 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-link.1 @@ -0,0 +1,57 @@ +.nh +.TH "GH-PROJECT-LINK" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-project-link - Link a project to a repository or a team + + +.SH SYNOPSIS +\fBgh project link [<number>] [flags]\fR + + +.SH OPTIONS +.TP +\fB--owner\fR \fB<string>\fR +Login of the owner. Use "@me" for the current user. + +.TP +\fB-R\fR, \fB--repo\fR \fB<string>\fR +The repository to be linked to this project + +.TP +\fB-T\fR, \fB--team\fR \fB<string>\fR +The team to be linked to this project + + +.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 +# Link monalisa's project 1 to her repository "my_repo" +$ gh project link 1 --owner monalisa --repo my_repo + +# Link monalisa's organization's project 1 to her team "my_team" +$ gh project link 1 --owner my_organization --team my_team + +# Link monalisa's project 1 to the repository of current directory if neither --repo nor --team is specified +$ gh project link 1 + +.EE + + +.SH SEE ALSO +\fBgh-project(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-list.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-list.1 new file mode 100644 index 00000000..a9c46c19 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-list.1 @@ -0,0 +1,74 @@ +.nh +.TH "GH-PROJECT-LIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-project-list - List the projects for an owner + + +.SH SYNOPSIS +\fBgh project list [flags]\fR + + +.SH OPTIONS +.TP +\fB--closed\fR +Include closed projects + +.TP +\fB--format\fR \fB<string>\fR +Output format: {json} + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB-L\fR, \fB--limit\fR \fB<int> (default 30)\fR +Maximum number of projects to fetch + +.TP +\fB--owner\fR \fB<string>\fR +Login of the owner + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB-w\fR, \fB--web\fR +Open projects list in the browser + + +.SH ALIASES +gh project 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 EXAMPLE +.EX +# List the current user's projects +$ gh project list + +# List the projects for org github including closed projects +$ gh project list --owner github --closed + +.EE + + +.SH SEE ALSO +\fBgh-project(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-mark-template.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-mark-template.1 new file mode 100644 index 00000000..1981b650 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-mark-template.1 @@ -0,0 +1,62 @@ +.nh +.TH "GH-PROJECT-MARK-TEMPLATE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-project-mark-template - Mark a project as a template + + +.SH SYNOPSIS +\fBgh project mark-template [<number>] [flags]\fR + + +.SH OPTIONS +.TP +\fB--format\fR \fB<string>\fR +Output format: {json} + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--owner\fR \fB<string>\fR +Login of the org owner. + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB--undo\fR +Unmark the project as a template. + + +.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 +# Mark the github org's project "1" as a template +$ gh project mark-template 1 --owner "github" + +# Unmark the github org's project "1" as a template +$ gh project mark-template 1 --owner "github" --undo + +.EE + + +.SH SEE ALSO +\fBgh-project(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-unlink.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-unlink.1 new file mode 100644 index 00000000..8b974503 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-unlink.1 @@ -0,0 +1,57 @@ +.nh +.TH "GH-PROJECT-UNLINK" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-project-unlink - Unlink a project from a repository or a team + + +.SH SYNOPSIS +\fBgh project unlink [<number>] [flags]\fR + + +.SH OPTIONS +.TP +\fB--owner\fR \fB<string>\fR +Login of the owner. Use "@me" for the current user. + +.TP +\fB-R\fR, \fB--repo\fR \fB<string>\fR +The repository to be unlinked from this project + +.TP +\fB-T\fR, \fB--team\fR \fB<string>\fR +The team to be unlinked from this project + + +.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 +# Unlink monalisa's project 1 from her repository "my_repo" +$ gh project unlink 1 --owner monalisa --repo my_repo + +# Unlink monalisa's organization's project 1 from her team "my_team" +$ gh project unlink 1 --owner my_organization --team my_team + +# Unlink monalisa's project 1 from the repository of current directory if neither --repo nor --team is specified +$ gh project unlink 1 + +.EE + + +.SH SEE ALSO +\fBgh-project(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-view.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-view.1 new file mode 100644 index 00000000..73bc1c8e --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project-view.1 @@ -0,0 +1,62 @@ +.nh +.TH "GH-PROJECT-VIEW" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-project-view - View a project + + +.SH SYNOPSIS +\fBgh project view [<number>] [flags]\fR + + +.SH OPTIONS +.TP +\fB--format\fR \fB<string>\fR +Output format: {json} + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--owner\fR \fB<string>\fR +Login of the owner. Use "@me" for the current user. + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB-w\fR, \fB--web\fR +Open a project in the browser + + +.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 +# View the current user's project "1" +$ gh project view 1 + +# Open user monalisa's project "1" in the browser +$ gh project view 1 --owner monalisa --web + +.EE + + +.SH SEE ALSO +\fBgh-project(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-project.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project.1 new file mode 100644 index 00000000..f3299e3c --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-project.1 @@ -0,0 +1,126 @@ +.nh +.TH "GH-PROJECT" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-project - Work with GitHub Projects. + + +.SH SYNOPSIS +\fBgh project <command> [flags]\fR + + +.SH DESCRIPTION +Work with GitHub Projects. + +.PP +The minimum required scope for the token is: \fBproject\fR\&. +You can verify your token scope by running \fBgh auth status\fR and +add the \fBproject\fR scope by running \fBgh auth refresh -s project\fR\&. + + +.SH AVAILABLE COMMANDS +.TP +\fBgh-project-close(1)\fR +Close a project + +.TP +\fBgh-project-copy(1)\fR +Copy a project + +.TP +\fBgh-project-create(1)\fR +Create a project + +.TP +\fBgh-project-delete(1)\fR +Delete a project + +.TP +\fBgh-project-edit(1)\fR +Edit a project + +.TP +\fBgh-project-field-create(1)\fR +Create a field in a project + +.TP +\fBgh-project-field-delete(1)\fR +Delete a field in a project + +.TP +\fBgh-project-field-list(1)\fR +List the fields in a project + +.TP +\fBgh-project-item-add(1)\fR +Add a pull request or an issue to a project + +.TP +\fBgh-project-item-archive(1)\fR +Archive an item in a project + +.TP +\fBgh-project-item-create(1)\fR +Create a draft issue item in a project + +.TP +\fBgh-project-item-delete(1)\fR +Delete an item from a project by ID + +.TP +\fBgh-project-item-edit(1)\fR +Edit an item in a project + +.TP +\fBgh-project-item-list(1)\fR +List the items in a project + +.TP +\fBgh-project-link(1)\fR +Link a project to a repository or a team + +.TP +\fBgh-project-list(1)\fR +List the projects for an owner + +.TP +\fBgh-project-mark-template(1)\fR +Mark a project as a template + +.TP +\fBgh-project-unlink(1)\fR +Unlink a project from a repository or a team + +.TP +\fBgh-project-view(1)\fR +View a project + + +.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 +$ gh project create --owner monalisa --title "Roadmap" +$ gh project view 1 --owner cli --web +$ gh project field-list 1 --owner cli +$ gh project item-list 1 --owner cli + +.EE + + +.SH SEE ALSO +\fBgh(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-release-create.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-release-create.1 new file mode 100644 index 00000000..aaad7068 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-release-create.1 @@ -0,0 +1,163 @@ +.nh +.TH "GH-RELEASE-CREATE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-release-create - Create a new release + + +.SH SYNOPSIS +\fBgh release create [<tag>] [<filename>... | <pattern>...]\fR + + +.SH DESCRIPTION +Create a new GitHub Release for a repository. + +.PP +A list of asset files may be given to upload to the new release. To define a +display label for an asset, append text starting with \fB#\fR after the file name. + +.PP +If a matching git tag does not yet exist, one will automatically get created +from the latest state of the default branch. +Use \fB--target\fR to point to a different branch or commit for the automatic tag creation. +Use \fB--verify-tag\fR to abort the release if the tag doesn't already exist. +To fetch the new tag locally after the release, do \fBgit fetch --tags origin\fR\&. + +.PP +To create a release from an annotated git tag, first create one locally with +git, push the tag to GitHub, then run this command. +Use \fB--notes-from-tag\fR to automatically generate the release notes +from the annotated git tag. + +.PP +When using automatically generated release notes, a release title will also be automatically +generated unless a title was explicitly passed. Additional release notes can be prepended to +automatically generated notes by using the \fB--notes\fR flag. + +.PP +By default, the release is created even if there are no new commits since the last release. +This may result in the same or duplicate release which may not be desirable in some cases. +Use \fB--fail-on-no-commits\fR to fail if no new commits are available. This flag has no +effect if there are no existing releases or this is the very first release. + + +.SH OPTIONS +.TP +\fB--discussion-category\fR \fB<string>\fR +Start a discussion in the specified category + +.TP +\fB-d\fR, \fB--draft\fR +Save the release as a draft instead of publishing it + +.TP +\fB--fail-on-no-commits\fR +Fail if there are no commits since the last release (no impact on the first release) + +.TP +\fB--generate-notes\fR +Automatically generate title and notes for the release + +.TP +\fB--latest\fR +Mark this release as "Latest" (default [automatic based on date and version]). --latest=false to explicitly NOT set as latest + +.TP +\fB-n\fR, \fB--notes\fR \fB<string>\fR +Release notes + +.TP +\fB-F\fR, \fB--notes-file\fR \fB<file>\fR +Read release notes from file (use "-" to read from standard input) + +.TP +\fB--notes-from-tag\fR +Automatically generate notes from annotated tag + +.TP +\fB--notes-start-tag\fR \fB<string>\fR +Tag to use as the starting point for generating release notes + +.TP +\fB-p\fR, \fB--prerelease\fR +Mark the release as a prerelease + +.TP +\fB--target\fR \fB<branch>\fR +Target branch or full commit SHA (default [main branch]) + +.TP +\fB-t\fR, \fB--title\fR \fB<string>\fR +Release title + +.TP +\fB--verify-tag\fR +Abort in case the git tag doesn't already exist in the remote repository + + +.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 release 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 +# Interactively create a release +$ gh release create + +# Interactively create a release from specific tag +$ gh release create v1.2.3 + +# Non-interactively create a release +$ gh release create v1.2.3 --notes "bugfix release" + +# Use automatically generated release notes +$ gh release create v1.2.3 --generate-notes + +# Use release notes from a file +$ gh release create v1.2.3 -F release-notes.md + +# Use annotated tag notes +$ gh release create v1.2.3 --notes-from-tag + +# Don't mark the release as latest +$ gh release create v1.2.3 --latest=false + +# Upload all tarballs in a directory as release assets +$ gh release create v1.2.3 ./dist/*.tgz + +# Upload a release asset with a display label +$ gh release create v1.2.3 '/path/to/asset.zip#My display label' + +# Create a release and start a discussion +$ gh release create v1.2.3 --discussion-category "General" + +# Create a release only if there are new commits available since the last release +$ gh release create v1.2.3 --fail-on-no-commits + +.EE + + +.SH SEE ALSO +\fBgh-release(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-release-delete-asset.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-release-delete-asset.1 new file mode 100644 index 00000000..dfc3f504 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-release-delete-asset.1 @@ -0,0 +1,41 @@ +.nh +.TH "GH-RELEASE-DELETE-ASSET" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-release-delete-asset - Delete an asset from a release + + +.SH SYNOPSIS +\fBgh release delete-asset <tag> <asset-name> [flags]\fR + + +.SH OPTIONS +.TP +\fB-y\fR, \fB--yes\fR +Skip the confirmation prompt + + +.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-release(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-release-delete.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-release-delete.1 new file mode 100644 index 00000000..ea038314 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-release-delete.1 @@ -0,0 +1,45 @@ +.nh +.TH "GH-RELEASE-DELETE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-release-delete - Delete a release + + +.SH SYNOPSIS +\fBgh release delete <tag> [flags]\fR + + +.SH OPTIONS +.TP +\fB--cleanup-tag\fR +Delete the specified tag in addition to its release + +.TP +\fB-y\fR, \fB--yes\fR +Skip the confirmation prompt + + +.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-release(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-release-download.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-release-download.1 new file mode 100644 index 00000000..5ce67924 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-release-download.1 @@ -0,0 +1,87 @@ +.nh +.TH "GH-RELEASE-DOWNLOAD" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-release-download - Download release assets + + +.SH SYNOPSIS +\fBgh release download [<tag>] [flags]\fR + + +.SH DESCRIPTION +Download assets from a GitHub release. + +.PP +Without an explicit tag name argument, assets are downloaded from the +latest release in the project. In this case, \fB--pattern\fR or \fB--archive\fR +is required. + + +.SH OPTIONS +.TP +\fB-A\fR, \fB--archive\fR \fB<format>\fR +Download the source code archive in the specified format (zip or tar.gz) + +.TP +\fB--clobber\fR +Overwrite existing files of the same name + +.TP +\fB-D\fR, \fB--dir\fR \fB<directory> (default ".")\fR +The directory to download files into + +.TP +\fB-O\fR, \fB--output\fR \fB<file>\fR +The file to write a single asset to (use "-" to write to standard output) + +.TP +\fB-p\fR, \fB--pattern\fR \fB<stringArray>\fR +Download only assets that match a glob pattern + +.TP +\fB--skip-existing\fR +Skip downloading when files of the same name exist + + +.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 +# Download all assets from a specific release +$ gh release download v1.2.3 + +# Download only Debian packages for the latest release +$ gh release download --pattern '*.deb' + +# Specify multiple file patterns +$ gh release download -p '*.deb' -p '*.rpm' + +# Download the archive of the source code for a release +$ gh release download v1.2.3 --archive=zip + +.EE + + +.SH SEE ALSO +\fBgh-release(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-release-edit.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-release-edit.1 new file mode 100644 index 00000000..dfd65303 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-release-edit.1 @@ -0,0 +1,88 @@ +.nh +.TH "GH-RELEASE-EDIT" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-release-edit - Edit a release + + +.SH SYNOPSIS +\fBgh release edit <tag>\fR + + +.SH OPTIONS +.TP +\fB--discussion-category\fR \fB<string>\fR +Start a discussion in the specified category when publishing a draft + +.TP +\fB--draft\fR +Save the release as a draft instead of publishing it + +.TP +\fB--latest\fR +Explicitly mark the release as "Latest" + +.TP +\fB-n\fR, \fB--notes\fR \fB<string>\fR +Release notes + +.TP +\fB-F\fR, \fB--notes-file\fR \fB<file>\fR +Read release notes from file (use "-" to read from standard input) + +.TP +\fB--prerelease\fR +Mark the release as a prerelease + +.TP +\fB--tag\fR \fB<string>\fR +The name of the tag + +.TP +\fB--target\fR \fB<branch>\fR +Target branch or full commit SHA (default [main branch]) + +.TP +\fB-t\fR, \fB--title\fR \fB<string>\fR +Release title + +.TP +\fB--verify-tag\fR +Abort in case the git tag doesn't already exist in the remote repository + + +.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 +# Publish a release that was previously a draft +$ gh release edit v1.0 --draft=false + +# Update the release notes from the content of a file +$ gh release edit v1.0 --notes-file /path/to/release_notes.md + +.EE + + +.SH SEE ALSO +\fBgh-release(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-release-list.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-release-list.1 new file mode 100644 index 00000000..6cc057ca --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-release-list.1 @@ -0,0 +1,73 @@ +.nh +.TH "GH-RELEASE-LIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-release-list - List releases in a repository + + +.SH SYNOPSIS +\fBgh release list [flags]\fR + + +.SH OPTIONS +.TP +\fB--exclude-drafts\fR +Exclude draft releases + +.TP +\fB--exclude-pre-releases\fR +Exclude pre-releases + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB<fields>\fR +Output JSON with the specified fields + +.TP +\fB-L\fR, \fB--limit\fR \fB<int> (default 30)\fR +Maximum number of items to fetch + +.TP +\fB-O\fR, \fB--order\fR \fB<string> (default "desc")\fR +Order of releases returned: {asc|desc} + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\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 release ls + + +.SH JSON FIELDS +\fBcreatedAt\fR, \fBisDraft\fR, \fBisLatest\fR, \fBisPrerelease\fR, \fBname\fR, \fBpublishedAt\fR, \fBtagName\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-release(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-release-upload.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-release-upload.1 new file mode 100644 index 00000000..de3efa41 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-release-upload.1 @@ -0,0 +1,49 @@ +.nh +.TH "GH-RELEASE-UPLOAD" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-release-upload - Upload assets to a release + + +.SH SYNOPSIS +\fBgh release upload <tag> <files>... [flags]\fR + + +.SH DESCRIPTION +Upload asset files to a GitHub Release. + +.PP +To define a display label for an asset, append text starting with \fB#\fR after the +file name. + + +.SH OPTIONS +.TP +\fB--clobber\fR +Overwrite existing assets of the same name + + +.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-release(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-release-view.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-release-view.1 new file mode 100644 index 00000000..891413e3 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-release-view.1 @@ -0,0 +1,65 @@ +.nh +.TH "GH-RELEASE-VIEW" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-release-view - View information about a release + + +.SH SYNOPSIS +\fBgh release view [<tag>] [flags]\fR + + +.SH DESCRIPTION +View information about a GitHub Release. + +.PP +Without an explicit tag name argument, the latest release in the project +is shown. + + +.SH OPTIONS +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB<fields>\fR +Output JSON with the specified fields + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB-w\fR, \fB--web\fR +Open the release in the 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 JSON FIELDS +\fBapiUrl\fR, \fBassets\fR, \fBauthor\fR, \fBbody\fR, \fBcreatedAt\fR, \fBdatabaseId\fR, \fBid\fR, \fBisDraft\fR, \fBisImmutable\fR, \fBisPrerelease\fR, \fBname\fR, \fBpublishedAt\fR, \fBtagName\fR, \fBtarballUrl\fR, \fBtargetCommitish\fR, \fBuploadUrl\fR, \fBurl\fR, \fBzipballUrl\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-release(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-release.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-release.1 new file mode 100644 index 00000000..efbd71cb --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-release.1 @@ -0,0 +1,71 @@ +.nh +.TH "GH-RELEASE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-release - Manage releases + + +.SH SYNOPSIS +\fBgh release <command> [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/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-archive.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-archive.1 new file mode 100644 index 00000000..190bdc3b --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-archive.1 @@ -0,0 +1,42 @@ +.nh +.TH "GH-REPO-ARCHIVE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-repo-archive - Archive a repository + + +.SH SYNOPSIS +\fBgh repo archive [<repository>] [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/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-autolink-create.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-autolink-create.1 new file mode 100644 index 00000000..c1f86ba1 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-autolink-create.1 @@ -0,0 +1,82 @@ +.nh +.TH "GH-REPO-AUTOLINK-CREATE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-repo-autolink-create - Create a new autolink reference + + +.SH SYNOPSIS +\fBgh repo autolink create <keyPrefix> <urlTemplate> [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<num>\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<num>\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<num>\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=<num>" + +# 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=<num>" --numeric + +.EE + + +.SH SEE ALSO +\fBgh-repo-autolink(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-autolink-delete.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-autolink-delete.1 new file mode 100644 index 00000000..7bd69e90 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-autolink-delete.1 @@ -0,0 +1,45 @@ +.nh +.TH "GH-REPO-AUTOLINK-DELETE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-repo-autolink-delete - Delete an autolink reference + + +.SH SYNOPSIS +\fBgh repo autolink delete <id> [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/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-autolink-list.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-autolink-list.1 new file mode 100644 index 00000000..f26bacd7 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-autolink-list.1 @@ -0,0 +1,68 @@ +.nh +.TH "GH-REPO-AUTOLINK-LIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "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<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB<fields>\fR +Output JSON with the specified fields + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\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/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-autolink-view.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-autolink-view.1 new file mode 100644 index 00000000..52e53f55 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-autolink-view.1 @@ -0,0 +1,57 @@ +.nh +.TH "GH-REPO-AUTOLINK-VIEW" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-repo-autolink-view - View an autolink reference + + +.SH SYNOPSIS +\fBgh repo autolink view <id> [flags]\fR + + +.SH DESCRIPTION +View an autolink reference for a repository. + + +.SH OPTIONS +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB<fields>\fR +Output JSON with the specified fields + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\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/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-autolink.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-autolink.1 new file mode 100644 index 00000000..26c502c2 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-autolink.1 @@ -0,0 +1,64 @@ +.nh +.TH "GH-REPO-AUTOLINK" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-repo-autolink - Manage autolink references + + +.SH SYNOPSIS +\fBgh repo autolink <command> [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/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-clone.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-clone.1 new file mode 100644 index 00000000..2e778c14 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-clone.1 @@ -0,0 +1,79 @@ +.nh +.TH "GH-REPO-CLONE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-repo-clone - Clone a repository locally + + +.SH SYNOPSIS +\fBgh repo clone <repository> [<directory>] [-- <gitflags>...]\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<string> (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/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-create.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-create.1 new file mode 100644 index 00000000..02a24bb1 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-create.1 @@ -0,0 +1,154 @@ +.nh +.TH "GH-REPO-CREATE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-repo-create - Create a new repository + + +.SH SYNOPSIS +\fBgh repo create [<name>] [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<string>\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<string>\fR +Specify a gitignore template for the repository + +.TP +\fB-h\fR, \fB--homepage\fR \fB<URL>\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<string>\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<string>\fR +Specify remote name for the new repository + +.TP +\fB-s\fR, \fB--source\fR \fB<string>\fR +Specify path to local repository to use as source + +.TP +\fB-t\fR, \fB--team\fR \fB<name>\fR +The name of the organization team to be granted access + +.TP +\fB-p\fR, \fB--template\fR \fB<repository>\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/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-delete.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-delete.1 new file mode 100644 index 00000000..12c90bf3 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-delete.1 @@ -0,0 +1,46 @@ +.nh +.TH "GH-REPO-DELETE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-repo-delete - Delete a repository + + +.SH SYNOPSIS +\fBgh repo delete [<repository>] [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/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-deploy-key-add.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-deploy-key-add.1 new file mode 100644 index 00000000..9fdf9722 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-deploy-key-add.1 @@ -0,0 +1,63 @@ +.nh +.TH "GH-REPO-DEPLOY-KEY-ADD" "1" "Jul 2025" "GitHub CLI 2.76.2" "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 <key-file> [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<string>\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/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-deploy-key-delete.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-deploy-key-delete.1 new file mode 100644 index 00000000..01be4a00 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-deploy-key-delete.1 @@ -0,0 +1,35 @@ +.nh +.TH "GH-REPO-DEPLOY-KEY-DELETE" "1" "Jul 2025" "GitHub CLI 2.76.2" "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 <key-id> [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/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-deploy-key-list.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-deploy-key-list.1 new file mode 100644 index 00000000..440b402d --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-deploy-key-list.1 @@ -0,0 +1,57 @@ +.nh +.TH "GH-REPO-DEPLOY-KEY-LIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "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<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB<fields>\fR +Output JSON with the specified fields + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\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/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-deploy-key.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-deploy-key.1 new file mode 100644 index 00000000..8c98a5b9 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-deploy-key.1 @@ -0,0 +1,49 @@ +.nh +.TH "GH-REPO-DEPLOY-KEY" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-repo-deploy-key - Manage deploy keys in a repository + + +.SH SYNOPSIS +\fBgh repo deploy-key <command> [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/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-edit.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-edit.1 new file mode 100644 index 00000000..6e9ba5a5 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-edit.1 @@ -0,0 +1,155 @@ +.nh +.TH "GH-REPO-EDIT" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-repo-edit - Edit repository settings + + +.SH SYNOPSIS +\fBgh repo edit [<repository>] [flags]\fR + + +.SH DESCRIPTION +Edit repository settings. + +.PP +To toggle a setting off, use the \fB--<flag>=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<strings>\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<name>\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<string>\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<URL>\fR +Repository home page URL + +.TP +\fB--remove-topic\fR \fB<strings>\fR +Remove repository topic + +.TP +\fB--template\fR +Make the repository available as a template repository + +.TP +\fB--visibility\fR \fB<string>\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/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-fork.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-fork.1 new file mode 100644 index 00000000..bd8010d0 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-fork.1 @@ -0,0 +1,74 @@ +.nh +.TH "GH-REPO-FORK" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-repo-fork - Create a fork of a repository + + +.SH SYNOPSIS +\fBgh repo fork [<repository>] [-- <gitflags>...] [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<string>\fR +Rename the forked repository + +.TP +\fB--org\fR \fB<string>\fR +Create the fork in an organization + +.TP +\fB--remote\fR +Add a git remote for the fork + +.TP +\fB--remote-name\fR \fB<string> (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/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-gitignore-list.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-gitignore-list.1 new file mode 100644 index 00000000..e49142bb --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-gitignore-list.1 @@ -0,0 +1,33 @@ +.nh +.TH "GH-REPO-GITIGNORE-LIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "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/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-gitignore-view.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-gitignore-view.1 new file mode 100644 index 00000000..1c5c2598 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-gitignore-view.1 @@ -0,0 +1,56 @@ +.nh +.TH "GH-REPO-GITIGNORE-VIEW" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-repo-gitignore-view - View an available repository gitignore template + + +.SH SYNOPSIS +\fBgh repo gitignore view <template> [flags]\fR + + +.SH DESCRIPTION +View an available repository \fB\&.gitignore\fR template. + +.PP +\fB<template>\fR is a case-sensitive \fB\&.gitignore\fR template name. + +.PP +For a list of available templates, run \fBgh repo gitignore list\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 EXAMPLE +.EX +# View the Go gitignore template +$ gh repo gitignore view Go + +# View the Python gitignore template +$ gh repo gitignore view Python + +# Create a new .gitignore file using the Go template +$ gh repo gitignore view Go > .gitignore + +# Create a new .gitignore file using the Python template +$ gh repo gitignore view Python > .gitignore + +.EE + + +.SH SEE ALSO +\fBgh-repo-gitignore(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-gitignore.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-gitignore.1 new file mode 100644 index 00000000..c999815e --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-gitignore.1 @@ -0,0 +1,39 @@ +.nh +.TH "GH-REPO-GITIGNORE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-repo-gitignore - List and view available repository gitignore templates + + +.SH SYNOPSIS +\fBgh repo gitignore <command> [flags]\fR + + +.SH AVAILABLE COMMANDS +.TP +\fBgh-repo-gitignore-list(1)\fR +List available repository gitignore templates + +.TP +\fBgh-repo-gitignore-view(1)\fR +View an available repository gitignore template + + +.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/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-license-list.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-license-list.1 new file mode 100644 index 00000000..f08f77dc --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-license-list.1 @@ -0,0 +1,41 @@ +.nh +.TH "GH-REPO-LICENSE-LIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-repo-license-list - List common repository licenses + + +.SH SYNOPSIS +\fBgh repo license list [flags]\fR + + +.SH DESCRIPTION +List common repository licenses. + +.PP +For even more licenses, visit +\[la]https://choosealicense.com/appendix\[ra] + + +.SH ALIASES +gh repo license 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-license(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-license-view.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-license-view.1 new file mode 100644 index 00000000..850425a1 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-license-view.1 @@ -0,0 +1,63 @@ +.nh +.TH "GH-REPO-LICENSE-VIEW" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-repo-license-view - View a specific repository license + + +.SH SYNOPSIS +\fBgh repo license view {<license-key> | <spdx-id>} [flags]\fR + + +.SH DESCRIPTION +View a specific repository license by license key or SPDX ID. + +.PP +Run \fBgh repo license list\fR to see available commonly used licenses. For even more licenses, visit +\[la]https://choosealicense.com/appendix\[ra]\&. + + +.SH OPTIONS +.TP +\fB-w\fR, \fB--web\fR +Open https://choosealicense.com/ in the browser + + +.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 +# View the MIT license from SPDX ID +$ gh repo license view MIT + +# View the MIT license from license key +$ gh repo license view mit + +# View the GNU AGPL-3.0 license from SPDX ID +$ gh repo license view AGPL-3.0 + +# View the GNU AGPL-3.0 license from license key +$ gh repo license view agpl-3.0 + +# Create a LICENSE.md with the MIT license +$ gh repo license view MIT > LICENSE.md + +.EE + + +.SH SEE ALSO +\fBgh-repo-license(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-license.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-license.1 new file mode 100644 index 00000000..905a6dd7 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-license.1 @@ -0,0 +1,39 @@ +.nh +.TH "GH-REPO-LICENSE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-repo-license - Explore repository licenses + + +.SH SYNOPSIS +\fBgh repo license <command> [flags]\fR + + +.SH AVAILABLE COMMANDS +.TP +\fBgh-repo-license-list(1)\fR +List common repository licenses + +.TP +\fBgh-repo-license-view(1)\fR +View a specific repository license + + +.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/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-list.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-list.1 new file mode 100644 index 00000000..11d0c5f4 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-list.1 @@ -0,0 +1,92 @@ +.nh +.TH "GH-REPO-LIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-repo-list - List repositories owned by user or organization + + +.SH SYNOPSIS +\fBgh repo list [<owner>] [flags]\fR + + +.SH DESCRIPTION +List repositories owned by a user or organization. + +.PP +Note that the list will only include repositories owned by the provided argument, +and the \fB--fork\fR or \fB--source\fR flags will not traverse ownership boundaries. For example, +when listing the forks in an organization, the output would not include those owned by individual users. + + +.SH OPTIONS +.TP +\fB--archived\fR +Show only archived repositories + +.TP +\fB--fork\fR +Show only forks + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB<fields>\fR +Output JSON with the specified fields + +.TP +\fB-l\fR, \fB--language\fR \fB<string>\fR +Filter by primary coding language + +.TP +\fB-L\fR, \fB--limit\fR \fB<int> (default 30)\fR +Maximum number of repositories to list + +.TP +\fB--no-archived\fR +Omit archived repositories + +.TP +\fB--source\fR +Show only non-forks + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB--topic\fR \fB<strings>\fR +Filter by topic + +.TP +\fB--visibility\fR \fB<string>\fR +Filter by repository visibility: {public|private|internal} + + +.SH ALIASES +gh repo ls + + +.SH JSON FIELDS +\fBarchivedAt\fR, \fBassignableUsers\fR, \fBcodeOfConduct\fR, \fBcontactLinks\fR, \fBcreatedAt\fR, \fBdefaultBranchRef\fR, \fBdeleteBranchOnMerge\fR, \fBdescription\fR, \fBdiskUsage\fR, \fBforkCount\fR, \fBfundingLinks\fR, \fBhasDiscussionsEnabled\fR, \fBhasIssuesEnabled\fR, \fBhasProjectsEnabled\fR, \fBhasWikiEnabled\fR, \fBhomepageUrl\fR, \fBid\fR, \fBisArchived\fR, \fBisBlankIssuesEnabled\fR, \fBisEmpty\fR, \fBisFork\fR, \fBisInOrganization\fR, \fBisMirror\fR, \fBisPrivate\fR, \fBisSecurityPolicyEnabled\fR, \fBisTemplate\fR, \fBisUserConfigurationRepository\fR, \fBissueTemplates\fR, \fBissues\fR, \fBlabels\fR, \fBlanguages\fR, \fBlatestRelease\fR, \fBlicenseInfo\fR, \fBmentionableUsers\fR, \fBmergeCommitAllowed\fR, \fBmilestones\fR, \fBmirrorUrl\fR, \fBname\fR, \fBnameWithOwner\fR, \fBopenGraphImageUrl\fR, \fBowner\fR, \fBparent\fR, \fBprimaryLanguage\fR, \fBprojects\fR, \fBprojectsV2\fR, \fBpullRequestTemplates\fR, \fBpullRequests\fR, \fBpushedAt\fR, \fBrebaseMergeAllowed\fR, \fBrepositoryTopics\fR, \fBsecurityPolicyUrl\fR, \fBsquashMergeAllowed\fR, \fBsshUrl\fR, \fBstargazerCount\fR, \fBtemplateRepository\fR, \fBupdatedAt\fR, \fBurl\fR, \fBusesCustomOpenGraphImage\fR, \fBviewerCanAdminister\fR, \fBviewerDefaultCommitEmail\fR, \fBviewerDefaultMergeMethod\fR, \fBviewerHasStarred\fR, \fBviewerPermission\fR, \fBviewerPossibleCommitEmails\fR, \fBviewerSubscription\fR, \fBvisibility\fR, \fBwatchers\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(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-rename.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-rename.1 new file mode 100644 index 00000000..ddc8639e --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-rename.1 @@ -0,0 +1,70 @@ +.nh +.TH "GH-REPO-RENAME" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-repo-rename - Rename a repository + + +.SH SYNOPSIS +\fBgh repo rename [<new-name>] [flags]\fR + + +.SH DESCRIPTION +Rename a GitHub repository. + +.PP +\fB<new-name>\fR is the desired repository name without the owner. + +.PP +By default, the current repository is renamed. Otherwise, the repository specified +with \fB--repo\fR is renamed. + +.PP +To transfer repository ownership to another user account or organization, +you must follow additional steps on \fBgithub.com\fR\&. + +.PP +For more information on transferring repository ownership, see: + +\[la]https://docs.github.com/en/repositories/creating\-and\-managing\-repositories/transferring\-a\-repository\[ra] + + +.SH OPTIONS +.TP +\fB-R\fR, \fB--repo\fR \fB<[HOST/]OWNER/REPO>\fR +Select another repository using the [HOST/]OWNER/REPO format + +.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 EXAMPLE +.EX +# Rename the current repository (foo/bar -> foo/baz) +$ gh repo rename baz + +# Rename the specified repository (qux/quux -> qux/baz) +$ gh repo rename -R qux/quux baz + +.EE + + +.SH SEE ALSO +\fBgh-repo(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-set-default.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-set-default.1 new file mode 100644 index 00000000..6ff964ec --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-set-default.1 @@ -0,0 +1,74 @@ +.nh +.TH "GH-REPO-SET-DEFAULT" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-repo-set-default - Configure default repository for this directory + + +.SH SYNOPSIS +\fBgh repo set-default [<repository>] [flags]\fR + + +.SH DESCRIPTION +This command sets the default remote repository to use when querying the +GitHub API for the locally cloned repository. + +.PP +gh uses the default repository for things like: +.IP \(bu 2 +viewing and creating pull requests +.IP \(bu 2 +viewing and creating issues +.IP \(bu 2 +viewing and creating releases +.IP \(bu 2 +working with GitHub Actions + +.SS NOTE: gh does not use the default repository for managing repository and environment secrets. + +.SH OPTIONS +.TP +\fB-u\fR, \fB--unset\fR +Unset the current default repository + +.TP +\fB-v\fR, \fB--view\fR +View the current default repository + + +.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 +# Interactively select a default repository +$ gh repo set-default + +# Set a repository explicitly +$ gh repo set-default owner/repo + +# View the current default repository +$ gh repo set-default --view + +# Show more repository options in the interactive picker +$ git remote add newrepo https://github.com/owner/repo +$ gh repo set-default + +.EE + + +.SH SEE ALSO +\fBgh-repo(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-sync.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-sync.1 new file mode 100644 index 00000000..34b96f1c --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-sync.1 @@ -0,0 +1,75 @@ +.nh +.TH "GH-REPO-SYNC" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-repo-sync - Sync a repository + + +.SH SYNOPSIS +\fBgh repo sync [<destination-repository>] [flags]\fR + + +.SH DESCRIPTION +Sync destination repository from source repository. Syncing uses the default branch +of the source repository to update the matching branch on the destination +repository so they are equal. A fast forward update will be used except when the +\fB--force\fR flag is specified, then the two branches will +be synced using a hard reset. + +.PP +Without an argument, the local repository is selected as the destination repository. + +.PP +The source repository is the parent of the destination repository by default. +This can be overridden with the \fB--source\fR flag. + + +.SH OPTIONS +.TP +\fB-b\fR, \fB--branch\fR \fB<string>\fR +Branch to sync (default [default branch]) + +.TP +\fB--force\fR +Hard reset the branch of the destination repository to match the source repository + +.TP +\fB-s\fR, \fB--source\fR \fB<string>\fR +Source repository + + +.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 +# Sync local repository from remote parent +$ gh repo sync + +# Sync local repository from remote parent on specific branch +$ gh repo sync --branch v1 + +# Sync remote fork from its parent +$ gh repo sync owner/cli-fork + +# Sync remote repository from another remote repository +$ gh repo sync owner/repo --source owner2/repo2 + +.EE + + +.SH SEE ALSO +\fBgh-repo(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-unarchive.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-unarchive.1 new file mode 100644 index 00000000..88b2633d --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-unarchive.1 @@ -0,0 +1,42 @@ +.nh +.TH "GH-REPO-UNARCHIVE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-repo-unarchive - Unarchive a repository + + +.SH SYNOPSIS +\fBgh repo unarchive [<repository>] [flags]\fR + + +.SH DESCRIPTION +Unarchive a GitHub repository. + +.PP +With no argument, unarchives 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/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-view.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-view.1 new file mode 100644 index 00000000..f9e60da1 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo-view.1 @@ -0,0 +1,68 @@ +.nh +.TH "GH-REPO-VIEW" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-repo-view - View a repository + + +.SH SYNOPSIS +\fBgh repo view [<repository>] [flags]\fR + + +.SH DESCRIPTION +Display the description and the README of a GitHub repository. + +.PP +With no argument, the repository for the current directory is displayed. + +.PP +With \fB--web\fR, open the repository in a web browser instead. + +.PP +With \fB--branch\fR, view a specific branch of the repository. + + +.SH OPTIONS +.TP +\fB-b\fR, \fB--branch\fR \fB<string>\fR +View a specific branch of the repository + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB<fields>\fR +Output JSON with the specified fields + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB-w\fR, \fB--web\fR +Open a repository in the browser + + +.SH JSON FIELDS +\fBarchivedAt\fR, \fBassignableUsers\fR, \fBcodeOfConduct\fR, \fBcontactLinks\fR, \fBcreatedAt\fR, \fBdefaultBranchRef\fR, \fBdeleteBranchOnMerge\fR, \fBdescription\fR, \fBdiskUsage\fR, \fBforkCount\fR, \fBfundingLinks\fR, \fBhasDiscussionsEnabled\fR, \fBhasIssuesEnabled\fR, \fBhasProjectsEnabled\fR, \fBhasWikiEnabled\fR, \fBhomepageUrl\fR, \fBid\fR, \fBisArchived\fR, \fBisBlankIssuesEnabled\fR, \fBisEmpty\fR, \fBisFork\fR, \fBisInOrganization\fR, \fBisMirror\fR, \fBisPrivate\fR, \fBisSecurityPolicyEnabled\fR, \fBisTemplate\fR, \fBisUserConfigurationRepository\fR, \fBissueTemplates\fR, \fBissues\fR, \fBlabels\fR, \fBlanguages\fR, \fBlatestRelease\fR, \fBlicenseInfo\fR, \fBmentionableUsers\fR, \fBmergeCommitAllowed\fR, \fBmilestones\fR, \fBmirrorUrl\fR, \fBname\fR, \fBnameWithOwner\fR, \fBopenGraphImageUrl\fR, \fBowner\fR, \fBparent\fR, \fBprimaryLanguage\fR, \fBprojects\fR, \fBprojectsV2\fR, \fBpullRequestTemplates\fR, \fBpullRequests\fR, \fBpushedAt\fR, \fBrebaseMergeAllowed\fR, \fBrepositoryTopics\fR, \fBsecurityPolicyUrl\fR, \fBsquashMergeAllowed\fR, \fBsshUrl\fR, \fBstargazerCount\fR, \fBtemplateRepository\fR, \fBupdatedAt\fR, \fBurl\fR, \fBusesCustomOpenGraphImage\fR, \fBviewerCanAdminister\fR, \fBviewerDefaultCommitEmail\fR, \fBviewerDefaultMergeMethod\fR, \fBviewerHasStarred\fR, \fBviewerPermission\fR, \fBviewerPossibleCommitEmails\fR, \fBviewerSubscription\fR, \fBvisibility\fR, \fBwatchers\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(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo.1 new file mode 100644 index 00000000..f895b194 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-repo.1 @@ -0,0 +1,110 @@ +.nh +.TH "GH-REPO" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-repo - Manage repositories + + +.SH SYNOPSIS +\fBgh repo <command> [flags]\fR + + +.SH DESCRIPTION +Work with GitHub repositories. + + +.SH GENERAL COMMANDS +.TP +\fBgh-repo-create(1)\fR +Create a new repository + +.TP +\fBgh-repo-list(1)\fR +List repositories owned by user or organization + + +.SH TARGETED COMMANDS +.TP +\fBgh-repo-archive(1)\fR +Archive a repository + +.TP +\fBgh-repo-autolink(1)\fR +Manage autolink references + +.TP +\fBgh-repo-clone(1)\fR +Clone a repository locally + +.TP +\fBgh-repo-delete(1)\fR +Delete a repository + +.TP +\fBgh-repo-deploy-key(1)\fR +Manage deploy keys in a repository + +.TP +\fBgh-repo-edit(1)\fR +Edit repository settings + +.TP +\fBgh-repo-fork(1)\fR +Create a fork of a repository + +.TP +\fBgh-repo-gitignore(1)\fR +List and view available repository gitignore templates + +.TP +\fBgh-repo-license(1)\fR +Explore repository licenses + +.TP +\fBgh-repo-rename(1)\fR +Rename a repository + +.TP +\fBgh-repo-set-default(1)\fR +Configure default repository for this directory + +.TP +\fBgh-repo-sync(1)\fR +Sync a repository + +.TP +\fBgh-repo-unarchive(1)\fR +Unarchive a repository + +.TP +\fBgh-repo-view(1)\fR +View a repository + + +.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 +$ gh repo create +$ gh repo clone cli/cli +$ gh repo view --web + +.EE + + +.SH SEE ALSO +\fBgh(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-ruleset-check.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-ruleset-check.1 new file mode 100644 index 00000000..252ce22a --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-ruleset-check.1 @@ -0,0 +1,80 @@ +.nh +.TH "GH-RULESET-CHECK" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-ruleset-check - View rules that would apply to a given branch + + +.SH SYNOPSIS +\fBgh ruleset check [<branch>] [flags]\fR + + +.SH DESCRIPTION +View information about GitHub rules that apply to a given branch. + +.PP +The provided branch name does not need to exist; rules will be displayed that would apply +to a branch with that name. All rules are returned regardless of where they are configured. + +.PP +If no branch name is provided, then the current branch will be used. + +.PP +The \fB--default\fR flag can be used to view rules that apply to the default branch of the +repository. + + +.SH OPTIONS +.TP +\fB--default\fR +Check rules on default branch + +.TP +\fB-w\fR, \fB--web\fR +Open the branch rules page in a 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 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 +# View all rules that apply to the current branch +$ gh ruleset check + +# View all rules that apply to a branch named "my-branch" in a different repository +$ gh ruleset check my-branch --repo owner/repo + +# View all rules that apply to the default branch in a different repository +$ gh ruleset check --default --repo owner/repo + +# View a ruleset configured in a different repository or any of its parents +$ gh ruleset view 23 --repo owner/repo + +# View an organization-level ruleset +$ gh ruleset view 23 --org my-org + +.EE + + +.SH SEE ALSO +\fBgh-ruleset(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-ruleset-list.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-ruleset-list.1 new file mode 100644 index 00000000..ab15db3d --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-ruleset-list.1 @@ -0,0 +1,87 @@ +.nh +.TH "GH-RULESET-LIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-ruleset-list - List rulesets for a repository or organization + + +.SH SYNOPSIS +\fBgh ruleset list [flags]\fR + + +.SH DESCRIPTION +List GitHub rulesets for a repository or organization. + +.PP +If no options are provided, the current repository's rulesets are listed. You can query a different +repository's rulesets by using the \fB--repo\fR flag. You can also use the \fB--org\fR flag to list rulesets +configured for the provided organization. + +.PP +Use the \fB--parents\fR flag to control whether rulesets configured at higher levels that also apply to the provided +repository or organization should be returned. The default is \fBtrue\fR\&. + +.PP +Your access token must have the \fBadmin:org\fR scope to use the \fB--org\fR flag, which can be granted by running \fBgh auth refresh -s admin:org\fR\&. + + +.SH OPTIONS +.TP +\fB-L\fR, \fB--limit\fR \fB<int> (default 30)\fR +Maximum number of rulesets to list + +.TP +\fB-o\fR, \fB--org\fR \fB<string>\fR +List organization-wide rulesets for the provided organization + +.TP +\fB-p\fR, \fB--parents\fR \fB(default true)\fR +Whether to include rulesets configured at higher levels that also apply + +.TP +\fB-w\fR, \fB--web\fR +Open the list of rulesets 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 rs ls, gh ruleset 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 EXAMPLE +.EX +# List rulesets in the current repository +$ gh ruleset list + +# List rulesets in a different repository, including those configured at higher levels +$ gh ruleset list --repo owner/repo --parents + +# List rulesets in an organization +$ gh ruleset list --org org-name + +.EE + + +.SH SEE ALSO +\fBgh-ruleset(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-ruleset-view.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-ruleset-view.1 new file mode 100644 index 00000000..07370b1b --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-ruleset-view.1 @@ -0,0 +1,82 @@ +.nh +.TH "GH-RULESET-VIEW" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-ruleset-view - View information about a ruleset + + +.SH SYNOPSIS +\fBgh ruleset view [<ruleset-id>] [flags]\fR + + +.SH DESCRIPTION +View information about a GitHub ruleset. + +.PP +If no ID is provided, an interactive prompt will be used to choose +the ruleset to view. + +.PP +Use the \fB--parents\fR flag to control whether rulesets configured at higher +levels that also apply to the provided repository or organization should +be returned. The default is \fBtrue\fR\&. + + +.SH OPTIONS +.TP +\fB-o\fR, \fB--org\fR \fB<string>\fR +Organization name if the provided ID is an organization-level ruleset + +.TP +\fB-p\fR, \fB--parents\fR \fB(default true)\fR +Whether to include rulesets configured at higher levels that also apply + +.TP +\fB-w\fR, \fB--web\fR +Open the ruleset in the 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 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 +# Interactively choose a ruleset to view from all rulesets that apply to the current repository +$ gh ruleset view + +# Interactively choose a ruleset to view from only rulesets configured in the current repository +$ gh ruleset view --no-parents + +# View a ruleset configured in the current repository or any of its parents +$ gh ruleset view 43 + +# View a ruleset configured in a different repository or any of its parents +$ gh ruleset view 23 --repo owner/repo + +# View an organization-level ruleset +$ gh ruleset view 23 --org my-org + +.EE + + +.SH SEE ALSO +\fBgh-ruleset(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-ruleset.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-ruleset.1 new file mode 100644 index 00000000..debcfa62 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-ruleset.1 @@ -0,0 +1,67 @@ +.nh +.TH "GH-RULESET" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-ruleset - View info about repo rulesets + + +.SH SYNOPSIS +\fBgh ruleset <command> [flags]\fR + + +.SH DESCRIPTION +Repository rulesets are a way to define a set of rules that apply to a repository. +These commands allow you to view information about them. + + +.SH AVAILABLE COMMANDS +.TP +\fBgh-ruleset-check(1)\fR +View rules that would apply to a given branch + +.TP +\fBgh-ruleset-list(1)\fR +List rulesets for a repository or organization + +.TP +\fBgh-ruleset-view(1)\fR +View information about a ruleset + + +.SH OPTIONS +.TP +\fB-R\fR, \fB--repo\fR \fB<[HOST/]OWNER/REPO>\fR +Select another repository using the [HOST/]OWNER/REPO format + + +.SH ALIASES +gh rs + + +.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 +$ gh ruleset list +$ gh ruleset view --repo OWNER/REPO --web +$ gh ruleset check branch-name + +.EE + + +.SH SEE ALSO +\fBgh(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-run-cancel.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-run-cancel.1 new file mode 100644 index 00000000..b5eeec37 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-run-cancel.1 @@ -0,0 +1,35 @@ +.nh +.TH "GH-RUN-CANCEL" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-run-cancel - Cancel a workflow run + + +.SH SYNOPSIS +\fBgh run cancel [<run-id>] [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-run(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-run-delete.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-run-delete.1 new file mode 100644 index 00000000..dcb8790e --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-run-delete.1 @@ -0,0 +1,46 @@ +.nh +.TH "GH-RUN-DELETE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-run-delete - Delete a workflow run + + +.SH SYNOPSIS +\fBgh run delete [<run-id>] [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 EXAMPLE +.EX +# Interactively select a run to delete +$ gh run delete + +# Delete a specific run +$ gh run delete 12345 + +.EE + + +.SH SEE ALSO +\fBgh-run(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-run-download.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-run-download.1 new file mode 100644 index 00000000..b862d690 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-run-download.1 @@ -0,0 +1,80 @@ +.nh +.TH "GH-RUN-DOWNLOAD" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-run-download - Download artifacts generated by a workflow run + + +.SH SYNOPSIS +\fBgh run download [<run-id>] [flags]\fR + + +.SH DESCRIPTION +Download artifacts generated by a GitHub Actions workflow run. + +.PP +The contents of each artifact will be extracted under separate directories based on +the artifact name. If only a single artifact is specified, it will be extracted into +the current directory. + +.PP +By default, this command downloads the latest artifact created and uploaded through +GitHub Actions. Because workflows can delete or overwrite artifacts, \fB<run-id>\fR +must be used to select an artifact from a specific workflow run. + + +.SH OPTIONS +.TP +\fB-D\fR, \fB--dir\fR \fB<string> (default ".")\fR +The directory to download artifacts into + +.TP +\fB-n\fR, \fB--name\fR \fB<stringArray>\fR +Download artifacts that match any of the given names + +.TP +\fB-p\fR, \fB--pattern\fR \fB<stringArray>\fR +Download artifacts that match a glob pattern + + +.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 +# Download all artifacts generated by a workflow run +$ gh run download <run-id> + +# Download a specific artifact within a run +$ gh run download <run-id> -n <name> + +# Download specific artifacts across all runs in a repository +$ gh run download -n <name1> -n <name2> + +# Select artifacts to download interactively +$ gh run download + +.EE + + +.SH SEE ALSO +\fBgh-run(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-run-list.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-run-list.1 new file mode 100644 index 00000000..132681bb --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-run-list.1 @@ -0,0 +1,104 @@ +.nh +.TH "GH-RUN-LIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-run-list - List recent workflow runs + + +.SH SYNOPSIS +\fBgh run list [flags]\fR + + +.SH DESCRIPTION +List recent workflow runs. + +.PP +Note that providing the \fBworkflow_name\fR to the \fB-w\fR flag will not fetch disabled workflows. +Also pass the \fB-a\fR flag to fetch disabled workflow runs using the \fBworkflow_name\fR and the \fB-w\fR flag. + +.PP +Runs created by organization and enterprise ruleset workflows will not display a workflow name due to GitHub API limitations. + + +.SH OPTIONS +.TP +\fB-a\fR, \fB--all\fR +Include disabled workflows + +.TP +\fB-b\fR, \fB--branch\fR \fB<string>\fR +Filter runs by branch + +.TP +\fB-c\fR, \fB--commit\fR \fB<SHA>\fR +Filter runs by the SHA of the commit + +.TP +\fB--created\fR \fB<date>\fR +Filter runs by the date it was created + +.TP +\fB-e\fR, \fB--event\fR \fB<event>\fR +Filter runs by which event triggered the run + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB<fields>\fR +Output JSON with the specified fields + +.TP +\fB-L\fR, \fB--limit\fR \fB<int> (default 20)\fR +Maximum number of runs to fetch + +.TP +\fB-s\fR, \fB--status\fR \fB<string>\fR +Filter runs by status: {queued|completed|in_progress|requested|waiting|pending|action_required|cancelled|failure|neutral|skipped|stale|startup_failure|success|timed_out} + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB-u\fR, \fB--user\fR \fB<string>\fR +Filter runs by user who triggered the run + +.TP +\fB-w\fR, \fB--workflow\fR \fB<string>\fR +Filter runs by workflow + + +.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 run ls + + +.SH JSON FIELDS +\fBattempt\fR, \fBconclusion\fR, \fBcreatedAt\fR, \fBdatabaseId\fR, \fBdisplayTitle\fR, \fBevent\fR, \fBheadBranch\fR, \fBheadSha\fR, \fBname\fR, \fBnumber\fR, \fBstartedAt\fR, \fBstatus\fR, \fBupdatedAt\fR, \fBurl\fR, \fBworkflowDatabaseId\fR, \fBworkflowName\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-run(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-run-rerun.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-run-rerun.1 new file mode 100644 index 00000000..b10d4f02 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-run-rerun.1 @@ -0,0 +1,69 @@ +.nh +.TH "GH-RUN-RERUN" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-run-rerun - Rerun a run + + +.SH SYNOPSIS +\fBgh run rerun [<run-id>] [flags]\fR + + +.SH DESCRIPTION +Rerun an entire run, only failed jobs, or a specific job from a run. + +.PP +Note that due to historical reasons, the \fB--job\fR flag may not take what you expect. +Specifically, when navigating to a job in the browser, the URL looks like this: +\fBhttps://github.com/<owner>/<repo>/actions/runs/<run-id>/jobs/<number>\fR\&. + +.PP +However, this \fB<number>\fR should not be used with the \fB--job\fR flag and will result in the +API returning \fB404 NOT FOUND\fR\&. Instead, you can get the correct job IDs using the following command: + +.EX +gh run view <run-id> --json jobs --jq '.jobs[] | {name, databaseId}' +.EE + +.PP +You will need to use databaseId field for triggering job re-runs. + + +.SH OPTIONS +.TP +\fB-d\fR, \fB--debug\fR +Rerun with debug logging + +.TP +\fB--failed\fR +Rerun only failed jobs, including dependencies + +.TP +\fB-j\fR, \fB--job\fR \fB<string>\fR +Rerun a specific job ID from a run, including dependencies + + +.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-run(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-run-view.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-run-view.1 new file mode 100644 index 00000000..1e73be86 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-run-view.1 @@ -0,0 +1,122 @@ +.nh +.TH "GH-RUN-VIEW" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-run-view - View a summary of a workflow run + + +.SH SYNOPSIS +\fBgh run view [<run-id>] [flags]\fR + + +.SH DESCRIPTION +View a summary of a workflow run. + +.PP +Due to platform limitations, \fBgh\fR may not always be able to associate jobs with their +corresponding logs when using the primary method of fetching logs in zip format. + +.PP +In such cases, \fBgh\fR will attempt to fetch logs for each job individually via the API. +This fallback is slower and more resource-intensive. If more than 25 job logs are missing, +the operation will fail with an error. + +.PP +Additionally, due to similar platform constraints, some log lines may not be +associated with a specific step within a job. In these cases, the step name will +appear as \fBUNKNOWN STEP\fR in the log output. + + +.SH OPTIONS +.TP +\fB-a\fR, \fB--attempt\fR \fB<uint> (default 0)\fR +The attempt number of the workflow run + +.TP +\fB--exit-status\fR +Exit with non-zero status if run failed + +.TP +\fB-j\fR, \fB--job\fR \fB<string>\fR +View a specific job ID from a run + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB<fields>\fR +Output JSON with the specified fields + +.TP +\fB--log\fR +View full log for either a run or specific job + +.TP +\fB--log-failed\fR +View the log for any failed steps in a run or specific job + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB-v\fR, \fB--verbose\fR +Show job steps + +.TP +\fB-w\fR, \fB--web\fR +Open run in the 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 JSON FIELDS +\fBattempt\fR, \fBconclusion\fR, \fBcreatedAt\fR, \fBdatabaseId\fR, \fBdisplayTitle\fR, \fBevent\fR, \fBheadBranch\fR, \fBheadSha\fR, \fBjobs\fR, \fBname\fR, \fBnumber\fR, \fBstartedAt\fR, \fBstatus\fR, \fBupdatedAt\fR, \fBurl\fR, \fBworkflowDatabaseId\fR, \fBworkflowName\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 EXAMPLE +.EX +# Interactively select a run to view, optionally selecting a single job +$ gh run view + +# View a specific run +$ gh run view 12345 + +# View a specific run with specific attempt number +$ gh run view 12345 --attempt 3 + +# View a specific job within a run +$ gh run view --job 456789 + +# View the full log for a specific job +$ gh run view --log --job 456789 + +# Exit non-zero if a run failed +$ gh run view 0451 --exit-status && echo "run pending or passed" + +.EE + + +.SH SEE ALSO +\fBgh-run(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-run-watch.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-run-watch.1 new file mode 100644 index 00000000..d260681b --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-run-watch.1 @@ -0,0 +1,75 @@ +.nh +.TH "GH-RUN-WATCH" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-run-watch - Watch a run until it completes, showing its progress + + +.SH SYNOPSIS +\fBgh run watch <run-id> [flags]\fR + + +.SH DESCRIPTION +Watch a run until it completes, showing its progress. + +.PP +By default, all steps are displayed. The \fB--compact\fR option can be used to only +show the relevant/failed steps. + +.PP +This command does not support authenticating via fine grained PATs +as it is not currently possible to create a PAT with the \fBchecks:read\fR permission. + + +.SH OPTIONS +.TP +\fB--compact\fR +Show only relevant/failed steps + +.TP +\fB--exit-status\fR +Exit with non-zero status if run fails + +.TP +\fB-i\fR, \fB--interval\fR \fB<int> (default 3)\fR +Refresh interval in seconds + + +.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 +# Watch a run until it's done +$ gh run watch + +# Watch a run in compact mode +$ gh run watch --compact + +# Run some other command when the run is finished +$ gh run watch && notify-send 'run is done!' + +.EE + + +.SH SEE ALSO +\fBgh-run(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-run.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-run.1 new file mode 100644 index 00000000..4e6a88f9 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-run.1 @@ -0,0 +1,69 @@ +.nh +.TH "GH-RUN" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-run - View details about workflow runs + + +.SH SYNOPSIS +\fBgh run <command> [flags]\fR + + +.SH DESCRIPTION +List, view, and watch recent workflow runs from GitHub Actions. + + +.SH AVAILABLE COMMANDS +.TP +\fBgh-run-cancel(1)\fR +Cancel a workflow run + +.TP +\fBgh-run-delete(1)\fR +Delete a workflow run + +.TP +\fBgh-run-download(1)\fR +Download artifacts generated by a workflow run + +.TP +\fBgh-run-list(1)\fR +List recent workflow runs + +.TP +\fBgh-run-rerun(1)\fR +Rerun a run + +.TP +\fBgh-run-view(1)\fR +View a summary of a workflow run + +.TP +\fBgh-run-watch(1)\fR +Watch a run until it completes, showing its progress + + +.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/gh_2.76.2_macOS_amd64/share/man/man1/gh-search-code.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-search-code.1 new file mode 100644 index 00000000..8d95e7ab --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-search-code.1 @@ -0,0 +1,120 @@ +.nh +.TH "GH-SEARCH-CODE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-search-code - Search within code + + +.SH SYNOPSIS +\fBgh search code <query> [flags]\fR + + +.SH DESCRIPTION +Search within code in GitHub repositories. + +.PP +The search syntax is documented at: + +\[la]https://docs.github.com/search\-github/searching\-on\-github/searching\-code\[ra] + +.PP +Note that these search results are powered by what is now a legacy GitHub code search engine. +The results might not match what is seen on \fBgithub.com\fR, and new features like regex search +are not yet available via the GitHub API. + + +.SH OPTIONS +.TP +\fB--extension\fR \fB<string>\fR +Filter on file extension + +.TP +\fB--filename\fR \fB<string>\fR +Filter on filename + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB<fields>\fR +Output JSON with the specified fields + +.TP +\fB--language\fR \fB<string>\fR +Filter results by language + +.TP +\fB-L\fR, \fB--limit\fR \fB<int> (default 30)\fR +Maximum number of code results to fetch + +.TP +\fB--match\fR \fB<strings>\fR +Restrict search to file contents or file path: {file|path} + +.TP +\fB--owner\fR \fB<strings>\fR +Filter on owner + +.TP +\fB-R\fR, \fB--repo\fR \fB<strings>\fR +Filter on repository + +.TP +\fB--size\fR \fB<string>\fR +Filter on size range, in kilobytes + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB-w\fR, \fB--web\fR +Open the search query in the web browser + + +.SH JSON FIELDS +\fBpath\fR, \fBrepository\fR, \fBsha\fR, \fBtextMatches\fR, \fBurl\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 EXAMPLE +.EX +# Search code matching "react" and "lifecycle" +$ gh search code react lifecycle + +# Search code matching "error handling" +$ gh search code "error handling" + +# Search code matching "deque" in Python files +$ gh search code deque --language=python + +# Search code matching "cli" in repositories owned by microsoft organization +$ gh search code cli --owner=microsoft + +# Search code matching "panic" in the GitHub CLI repository +$ gh search code panic --repo cli/cli + +# Search code matching keyword "lint" in package.json files +$ gh search code lint --filename package.json + +.EE + + +.SH SEE ALSO +\fBgh-search(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-search-commits.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-search-commits.1 new file mode 100644 index 00000000..291beb7c --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-search-commits.1 @@ -0,0 +1,159 @@ +.nh +.TH "GH-SEARCH-COMMITS" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-search-commits - Search for commits + + +.SH SYNOPSIS +\fBgh search commits [<query>] [flags]\fR + + +.SH DESCRIPTION +Search for commits on GitHub. + +.PP +The command supports constructing queries using the GitHub search syntax, +using the parameter and qualifier flags, or a combination of the two. + +.PP +GitHub search syntax is documented at: + +\[la]https://docs.github.com/search\-github/searching\-on\-github/searching\-commits\[ra] + + +.SH OPTIONS +.TP +\fB--author\fR \fB<string>\fR +Filter by author + +.TP +\fB--author-date\fR \fB<date>\fR +Filter based on authored date + +.TP +\fB--author-email\fR \fB<string>\fR +Filter on author email + +.TP +\fB--author-name\fR \fB<string>\fR +Filter on author name + +.TP +\fB--committer\fR \fB<string>\fR +Filter by committer + +.TP +\fB--committer-date\fR \fB<date>\fR +Filter based on committed date + +.TP +\fB--committer-email\fR \fB<string>\fR +Filter on committer email + +.TP +\fB--committer-name\fR \fB<string>\fR +Filter on committer name + +.TP +\fB--hash\fR \fB<string>\fR +Filter by commit hash + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB<fields>\fR +Output JSON with the specified fields + +.TP +\fB-L\fR, \fB--limit\fR \fB<int> (default 30)\fR +Maximum number of commits to fetch + +.TP +\fB--merge\fR +Filter on merge commits + +.TP +\fB--order\fR \fB<string> (default "desc")\fR +Order of commits returned, ignored unless '--sort' flag is specified: {asc|desc} + +.TP +\fB--owner\fR \fB<strings>\fR +Filter on repository owner + +.TP +\fB--parent\fR \fB<string>\fR +Filter by parent hash + +.TP +\fB-R\fR, \fB--repo\fR \fB<strings>\fR +Filter on repository + +.TP +\fB--sort\fR \fB<string> (default "best-match")\fR +Sort fetched commits: {author-date|committer-date} + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB--tree\fR \fB<string>\fR +Filter by tree hash + +.TP +\fB--visibility\fR \fB<strings>\fR +Filter based on repository visibility: {public|private|internal} + +.TP +\fB-w\fR, \fB--web\fR +Open the search query in the web browser + + +.SH JSON FIELDS +\fBauthor\fR, \fBcommit\fR, \fBcommitter\fR, \fBid\fR, \fBparents\fR, \fBrepository\fR, \fBsha\fR, \fBurl\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 EXAMPLE +.EX +# Search commits matching set of keywords "readme" and "typo" +$ gh search commits readme typo + +# Search commits matching phrase "bug fix" +$ gh search commits "bug fix" + +# Search commits committed by user "monalisa" +$ gh search commits --committer=monalisa + +# Search commits authored by users with name "Jane Doe" +$ gh search commits --author-name="Jane Doe" + +# Search commits matching hash "8dd03144ffdc6c0d486d6b705f9c7fba871ee7c3" +$ gh search commits --hash=8dd03144ffdc6c0d486d6b705f9c7fba871ee7c3 + +# Search commits authored before February 1st, 2022 +$ gh search commits --author-date="<2022-02-01" + +.EE + + +.SH SEE ALSO +\fBgh-search(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-search-issues.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-search-issues.1 new file mode 100644 index 00000000..dfeeff7e --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-search-issues.1 @@ -0,0 +1,218 @@ +.nh +.TH "GH-SEARCH-ISSUES" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-search-issues - Search for issues + + +.SH SYNOPSIS +\fBgh search issues [<query>] [flags]\fR + + +.SH DESCRIPTION +Search for issues on GitHub. + +.PP +The command supports constructing queries using the GitHub search syntax, +using the parameter and qualifier flags, or a combination of the two. + +.PP +GitHub search syntax is documented at: + +\[la]https://docs.github.com/search\-github/searching\-on\-github/searching\-issues\-and\-pull\-requests\[ra] + + +.SH OPTIONS +.TP +\fB--app\fR \fB<string>\fR +Filter by GitHub App author + +.TP +\fB--archived\fR +Filter based on the repository archived state {true|false} + +.TP +\fB--assignee\fR \fB<string>\fR +Filter by assignee + +.TP +\fB--author\fR \fB<string>\fR +Filter by author + +.TP +\fB--closed\fR \fB<date>\fR +Filter on closed at date + +.TP +\fB--commenter\fR \fB<user>\fR +Filter based on comments by user + +.TP +\fB--comments\fR \fB<number>\fR +Filter on number of comments + +.TP +\fB--created\fR \fB<date>\fR +Filter based on created at date + +.TP +\fB--include-prs\fR +Include pull requests in results + +.TP +\fB--interactions\fR \fB<number>\fR +Filter on number of reactions and comments + +.TP +\fB--involves\fR \fB<user>\fR +Filter based on involvement of user + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB<fields>\fR +Output JSON with the specified fields + +.TP +\fB--label\fR \fB<strings>\fR +Filter on label + +.TP +\fB--language\fR \fB<string>\fR +Filter based on the coding language + +.TP +\fB-L\fR, \fB--limit\fR \fB<int> (default 30)\fR +Maximum number of results to fetch + +.TP +\fB--locked\fR +Filter on locked conversation status + +.TP +\fB--match\fR \fB<strings>\fR +Restrict search to specific field of issue: {title|body|comments} + +.TP +\fB--mentions\fR \fB<user>\fR +Filter based on user mentions + +.TP +\fB--milestone\fR \fB<title>\fR +Filter by milestone title + +.TP +\fB--no-assignee\fR +Filter on missing assignee + +.TP +\fB--no-label\fR +Filter on missing label + +.TP +\fB--no-milestone\fR +Filter on missing milestone + +.TP +\fB--no-project\fR +Filter on missing project + +.TP +\fB--order\fR \fB<string> (default "desc")\fR +Order of results returned, ignored unless '--sort' flag is specified: {asc|desc} + +.TP +\fB--owner\fR \fB<strings>\fR +Filter on repository owner + +.TP +\fB--project\fR \fB<owner/number>\fR +Filter on project board owner/number + +.TP +\fB--reactions\fR \fB<number>\fR +Filter on number of reactions + +.TP +\fB-R\fR, \fB--repo\fR \fB<strings>\fR +Filter on repository + +.TP +\fB--sort\fR \fB<string> (default "best-match")\fR +Sort fetched results: {comments|created|interactions|reactions|reactions-+1|reactions--1|reactions-heart|reactions-smile|reactions-tada|reactions-thinking_face|updated} + +.TP +\fB--state\fR \fB<string>\fR +Filter based on state: {open|closed} + +.TP +\fB--team-mentions\fR \fB<string>\fR +Filter based on team mentions + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB--updated\fR \fB<date>\fR +Filter on last updated at date + +.TP +\fB--visibility\fR \fB<strings>\fR +Filter based on repository visibility: {public|private|internal} + +.TP +\fB-w\fR, \fB--web\fR +Open the search query in the web browser + + +.SH JSON FIELDS +\fBassignees\fR, \fBauthor\fR, \fBauthorAssociation\fR, \fBbody\fR, \fBclosedAt\fR, \fBcommentsCount\fR, \fBcreatedAt\fR, \fBid\fR, \fBisLocked\fR, \fBisPullRequest\fR, \fBlabels\fR, \fBnumber\fR, \fBrepository\fR, \fBstate\fR, \fBtitle\fR, \fBupdatedAt\fR, \fBurl\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 EXAMPLE +.EX +# Search issues matching set of keywords "readme" and "typo" +$ gh search issues readme typo + +# Search issues matching phrase "broken feature" +$ gh search issues "broken feature" + +# Search issues and pull requests in cli organization +$ gh search issues --include-prs --owner=cli + +# Search open issues assigned to yourself +$ gh search issues --assignee=@me --state=open + +# Search issues with numerous comments +$ gh search issues --comments=">100" + +# Search issues without label "bug" +$ gh search issues -- -label:bug + +# Search issues only from un-archived repositories (default is all repositories) +$ gh search issues --owner github --archived=false + +.EE + + +.SH SEE ALSO +\fBgh-search(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-search-prs.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-search-prs.1 new file mode 100644 index 00000000..1f449f04 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-search-prs.1 @@ -0,0 +1,250 @@ +.nh +.TH "GH-SEARCH-PRS" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-search-prs - Search for pull requests + + +.SH SYNOPSIS +\fBgh search prs [<query>] [flags]\fR + + +.SH DESCRIPTION +Search for pull requests on GitHub. + +.PP +The command supports constructing queries using the GitHub search syntax, +using the parameter and qualifier flags, or a combination of the two. + +.PP +GitHub search syntax is documented at: + +\[la]https://docs.github.com/search\-github/searching\-on\-github/searching\-issues\-and\-pull\-requests\[ra] + + +.SH OPTIONS +.TP +\fB--app\fR \fB<string>\fR +Filter by GitHub App author + +.TP +\fB--archived\fR +Filter based on the repository archived state {true|false} + +.TP +\fB--assignee\fR \fB<string>\fR +Filter by assignee + +.TP +\fB--author\fR \fB<string>\fR +Filter by author + +.TP +\fB-B\fR, \fB--base\fR \fB<string>\fR +Filter on base branch name + +.TP +\fB--checks\fR \fB<string>\fR +Filter based on status of the checks: {pending|success|failure} + +.TP +\fB--closed\fR \fB<date>\fR +Filter on closed at date + +.TP +\fB--commenter\fR \fB<user>\fR +Filter based on comments by user + +.TP +\fB--comments\fR \fB<number>\fR +Filter on number of comments + +.TP +\fB--created\fR \fB<date>\fR +Filter based on created at date + +.TP +\fB--draft\fR +Filter based on draft state + +.TP +\fB-H\fR, \fB--head\fR \fB<string>\fR +Filter on head branch name + +.TP +\fB--interactions\fR \fB<number>\fR +Filter on number of reactions and comments + +.TP +\fB--involves\fR \fB<user>\fR +Filter based on involvement of user + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB<fields>\fR +Output JSON with the specified fields + +.TP +\fB--label\fR \fB<strings>\fR +Filter on label + +.TP +\fB--language\fR \fB<string>\fR +Filter based on the coding language + +.TP +\fB-L\fR, \fB--limit\fR \fB<int> (default 30)\fR +Maximum number of results to fetch + +.TP +\fB--locked\fR +Filter on locked conversation status + +.TP +\fB--match\fR \fB<strings>\fR +Restrict search to specific field of issue: {title|body|comments} + +.TP +\fB--mentions\fR \fB<user>\fR +Filter based on user mentions + +.TP +\fB--merged\fR +Filter based on merged state + +.TP +\fB--merged-at\fR \fB<date>\fR +Filter on merged at date + +.TP +\fB--milestone\fR \fB<title>\fR +Filter by milestone title + +.TP +\fB--no-assignee\fR +Filter on missing assignee + +.TP +\fB--no-label\fR +Filter on missing label + +.TP +\fB--no-milestone\fR +Filter on missing milestone + +.TP +\fB--no-project\fR +Filter on missing project + +.TP +\fB--order\fR \fB<string> (default "desc")\fR +Order of results returned, ignored unless '--sort' flag is specified: {asc|desc} + +.TP +\fB--owner\fR \fB<strings>\fR +Filter on repository owner + +.TP +\fB--project\fR \fB<owner/number>\fR +Filter on project board owner/number + +.TP +\fB--reactions\fR \fB<number>\fR +Filter on number of reactions + +.TP +\fB-R\fR, \fB--repo\fR \fB<strings>\fR +Filter on repository + +.TP +\fB--review\fR \fB<string>\fR +Filter based on review status: {none|required|approved|changes_requested} + +.TP +\fB--review-requested\fR \fB<user>\fR +Filter on user or team requested to review + +.TP +\fB--reviewed-by\fR \fB<user>\fR +Filter on user who reviewed + +.TP +\fB--sort\fR \fB<string> (default "best-match")\fR +Sort fetched results: {comments|reactions|reactions-+1|reactions--1|reactions-smile|reactions-thinking_face|reactions-heart|reactions-tada|interactions|created|updated} + +.TP +\fB--state\fR \fB<string>\fR +Filter based on state: {open|closed} + +.TP +\fB--team-mentions\fR \fB<string>\fR +Filter based on team mentions + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB--updated\fR \fB<date>\fR +Filter on last updated at date + +.TP +\fB--visibility\fR \fB<strings>\fR +Filter based on repository visibility: {public|private|internal} + +.TP +\fB-w\fR, \fB--web\fR +Open the search query in the web browser + + +.SH JSON FIELDS +\fBassignees\fR, \fBauthor\fR, \fBauthorAssociation\fR, \fBbody\fR, \fBclosedAt\fR, \fBcommentsCount\fR, \fBcreatedAt\fR, \fBid\fR, \fBisDraft\fR, \fBisLocked\fR, \fBisPullRequest\fR, \fBlabels\fR, \fBnumber\fR, \fBrepository\fR, \fBstate\fR, \fBtitle\fR, \fBupdatedAt\fR, \fBurl\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 EXAMPLE +.EX +# Search pull requests matching set of keywords "fix" and "bug" +$ gh search prs fix bug + +# Search draft pull requests in cli repository +$ gh search prs --repo=cli/cli --draft + +# Search open pull requests requesting your review +$ gh search prs --review-requested=@me --state=open + +# Search merged pull requests assigned to yourself +$ gh search prs --assignee=@me --merged + +# Search pull requests with numerous reactions +$ gh search prs --reactions=">100" + +# Search pull requests without label "bug" +$ gh search prs -- -label:bug + +# Search pull requests only from un-archived repositories (default is all repositories) +$ gh search prs --owner github --archived=false + +.EE + + +.SH SEE ALSO +\fBgh-search(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-search-repos.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-search-repos.1 new file mode 100644 index 00000000..9f87d3e6 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-search-repos.1 @@ -0,0 +1,170 @@ +.nh +.TH "GH-SEARCH-REPOS" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-search-repos - Search for repositories + + +.SH SYNOPSIS +\fBgh search repos [<query>] [flags]\fR + + +.SH DESCRIPTION +Search for repositories on GitHub. + +.PP +The command supports constructing queries using the GitHub search syntax, +using the parameter and qualifier flags, or a combination of the two. + +.PP +GitHub search syntax is documented at: + +\[la]https://docs.github.com/search\-github/searching\-on\-github/searching\-for\-repositories\[ra] + + +.SH OPTIONS +.TP +\fB--archived\fR +Filter based on the repository archived state {true|false} + +.TP +\fB--created\fR \fB<date>\fR +Filter based on created at date + +.TP +\fB--followers\fR \fB<number>\fR +Filter based on number of followers + +.TP +\fB--forks\fR \fB<number>\fR +Filter on number of forks + +.TP +\fB--good-first-issues\fR \fB<number>\fR +Filter on number of issues with the 'good first issue' label + +.TP +\fB--help-wanted-issues\fR \fB<number>\fR +Filter on number of issues with the 'help wanted' label + +.TP +\fB--include-forks\fR \fB<string>\fR +Include forks in fetched repositories: {false|true|only} + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB<fields>\fR +Output JSON with the specified fields + +.TP +\fB--language\fR \fB<string>\fR +Filter based on the coding language + +.TP +\fB--license\fR \fB<strings>\fR +Filter based on license type + +.TP +\fB-L\fR, \fB--limit\fR \fB<int> (default 30)\fR +Maximum number of repositories to fetch + +.TP +\fB--match\fR \fB<strings>\fR +Restrict search to specific field of repository: {name|description|readme} + +.TP +\fB--number-topics\fR \fB<number>\fR +Filter on number of topics + +.TP +\fB--order\fR \fB<string> (default "desc")\fR +Order of repositories returned, ignored unless '--sort' flag is specified: {asc|desc} + +.TP +\fB--owner\fR \fB<strings>\fR +Filter on owner + +.TP +\fB--size\fR \fB<string>\fR +Filter on a size range, in kilobytes + +.TP +\fB--sort\fR \fB<string> (default "best-match")\fR +Sort fetched repositories: {forks|help-wanted-issues|stars|updated} + +.TP +\fB--stars\fR \fB<number>\fR +Filter on number of stars + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB--topic\fR \fB<strings>\fR +Filter on topic + +.TP +\fB--updated\fR \fB<date>\fR +Filter on last updated at date + +.TP +\fB--visibility\fR \fB<strings>\fR +Filter based on visibility: {public|private|internal} + +.TP +\fB-w\fR, \fB--web\fR +Open the search query in the web browser + + +.SH JSON FIELDS +\fBcreatedAt\fR, \fBdefaultBranch\fR, \fBdescription\fR, \fBforksCount\fR, \fBfullName\fR, \fBhasDownloads\fR, \fBhasIssues\fR, \fBhasPages\fR, \fBhasProjects\fR, \fBhasWiki\fR, \fBhomepage\fR, \fBid\fR, \fBisArchived\fR, \fBisDisabled\fR, \fBisFork\fR, \fBisPrivate\fR, \fBlanguage\fR, \fBlicense\fR, \fBname\fR, \fBopenIssuesCount\fR, \fBowner\fR, \fBpushedAt\fR, \fBsize\fR, \fBstargazersCount\fR, \fBupdatedAt\fR, \fBurl\fR, \fBvisibility\fR, \fBwatchersCount\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 EXAMPLE +.EX +# Search repositories matching set of keywords "cli" and "shell" +$ gh search repos cli shell + +# Search repositories matching phrase "vim plugin" +$ gh search repos "vim plugin" + +# Search repositories public repos in the microsoft organization +$ gh search repos --owner=microsoft --visibility=public + +# Search repositories with a set of topics +$ gh search repos --topic=unix,terminal + +# Search repositories by coding language and number of good first issues +$ gh search repos --language=go --good-first-issues=">=10" + +# Search repositories without topic "linux" +$ gh search repos -- -topic:linux + +# Search repositories excluding archived repositories +$ gh search repos --archived=false + +.EE + + +.SH SEE ALSO +\fBgh-search(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-search.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-search.1 new file mode 100644 index 00000000..d26daf89 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-search.1 @@ -0,0 +1,55 @@ +.nh +.TH "GH-SEARCH" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-search - Search for repositories, issues, and pull requests + + +.SH SYNOPSIS +\fBgh search <command> [flags]\fR + + +.SH DESCRIPTION +Search across all of GitHub. + + +.SH AVAILABLE COMMANDS +.TP +\fBgh-search-code(1)\fR +Search within code + +.TP +\fBgh-search-commits(1)\fR +Search for commits + +.TP +\fBgh-search-issues(1)\fR +Search for issues + +.TP +\fBgh-search-prs(1)\fR +Search for pull requests + +.TP +\fBgh-search-repos(1)\fR +Search for repositories + + +.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/gh_2.76.2_macOS_amd64/share/man/man1/gh-secret-delete.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-secret-delete.1 new file mode 100644 index 00000000..be0aa4be --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-secret-delete.1 @@ -0,0 +1,65 @@ +.nh +.TH "GH-SECRET-DELETE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-secret-delete - Delete secrets + + +.SH SYNOPSIS +\fBgh secret delete <secret-name> [flags]\fR + + +.SH DESCRIPTION +Delete a secret on one of the following levels: +- repository (default): available to GitHub Actions runs or Dependabot in a repository +- environment: available to GitHub Actions runs for a deployment environment in a repository +- organization: available to GitHub Actions runs, Dependabot, or Codespaces within an organization +- user: available to Codespaces for your user + + +.SH OPTIONS +.TP +\fB-a\fR, \fB--app\fR \fB<string>\fR +Delete a secret for a specific application: {actions|codespaces|dependabot} + +.TP +\fB-e\fR, \fB--env\fR \fB<string>\fR +Delete a secret for an environment + +.TP +\fB-o\fR, \fB--org\fR \fB<string>\fR +Delete a secret for an organization + +.TP +\fB-u\fR, \fB--user\fR +Delete a secret for your user + + +.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 secret remove + + +.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-secret(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-secret-list.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-secret-list.1 new file mode 100644 index 00000000..ca29af63 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-secret-list.1 @@ -0,0 +1,81 @@ +.nh +.TH "GH-SECRET-LIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-secret-list - List secrets + + +.SH SYNOPSIS +\fBgh secret list [flags]\fR + + +.SH DESCRIPTION +List secrets on one of the following levels: +- repository (default): available to GitHub Actions runs or Dependabot in a repository +- environment: available to GitHub Actions runs for a deployment environment in a repository +- organization: available to GitHub Actions runs, Dependabot, or Codespaces within an organization +- user: available to Codespaces for your user + + +.SH OPTIONS +.TP +\fB-a\fR, \fB--app\fR \fB<string>\fR +List secrets for a specific application: {actions|codespaces|dependabot} + +.TP +\fB-e\fR, \fB--env\fR \fB<string>\fR +List secrets for an environment + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB<fields>\fR +Output JSON with the specified fields + +.TP +\fB-o\fR, \fB--org\fR \fB<string>\fR +List secrets for an organization + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\fR +Format JSON output using a Go template; see "gh help formatting" + +.TP +\fB-u\fR, \fB--user\fR +List a secret for your user + + +.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 secret ls + + +.SH JSON FIELDS +\fBname\fR, \fBnumSelectedRepos\fR, \fBselectedReposURL\fR, \fBupdatedAt\fR, \fBvisibility\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-secret(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-secret-set.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-secret-set.1 new file mode 100644 index 00000000..be70f4e5 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-secret-set.1 @@ -0,0 +1,133 @@ +.nh +.TH "GH-SECRET-SET" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-secret-set - Create or update secrets + + +.SH SYNOPSIS +\fBgh secret set <secret-name> [flags]\fR + + +.SH DESCRIPTION +Set a value for a secret on one of the following levels: +- repository (default): available to GitHub Actions runs or Dependabot in a repository +- environment: available to GitHub Actions runs for a deployment environment in a repository +- organization: available to GitHub Actions runs, Dependabot, or Codespaces within an organization +- user: available to Codespaces for your user + +.PP +Organization and user secrets can optionally be restricted to only be available to +specific repositories. + +.PP +Secret values are locally encrypted before being sent to GitHub. + + +.SH OPTIONS +.TP +\fB-a\fR, \fB--app\fR \fB<string>\fR +Set the application for a secret: {actions|codespaces|dependabot} + +.TP +\fB-b\fR, \fB--body\fR \fB<string>\fR +The value for the secret (reads from standard input if not specified) + +.TP +\fB-e\fR, \fB--env\fR \fB<environment>\fR +Set deployment environment secret + +.TP +\fB-f\fR, \fB--env-file\fR \fB<file>\fR +Load secret names and values from a dotenv-formatted file + +.TP +\fB--no-repos-selected\fR +No repositories can access the organization secret + +.TP +\fB--no-store\fR +Print the encrypted, base64-encoded value instead of storing it on GitHub + +.TP +\fB-o\fR, \fB--org\fR \fB<organization>\fR +Set organization secret + +.TP +\fB-r\fR, \fB--repos\fR \fB<repositories>\fR +List of repositories that can access an organization or user secret + +.TP +\fB-u\fR, \fB--user\fR +Set a secret for your user + +.TP +\fB-v\fR, \fB--visibility\fR \fB<string> (default "private")\fR +Set visibility for an organization secret: {all|private|selected} + + +.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 +# Paste secret value for the current repository in an interactive prompt +$ gh secret set MYSECRET + +# Read secret value from an environment variable +$ gh secret set MYSECRET --body "$ENV_VALUE" + +# Set secret for a specific remote repository +$ gh secret set MYSECRET --repo origin/repo --body "$ENV_VALUE" + +# Read secret value from a file +$ gh secret set MYSECRET < myfile.txt + +# Set secret for a deployment environment in the current repository +$ gh secret set MYSECRET --env myenvironment + +# Set organization-level secret visible to both public and private repositories +$ gh secret set MYSECRET --org myOrg --visibility all + +# Set organization-level secret visible to specific repositories +$ gh secret set MYSECRET --org myOrg --repos repo1,repo2,repo3 + +# Set organization-level secret visible to no repositories +$ gh secret set MYSECRET --org myOrg --no-repos-selected + +# Set user-level secret for Codespaces +$ gh secret set MYSECRET --user + +# Set repository-level secret for Dependabot +$ gh secret set MYSECRET --app dependabot + +# Set multiple secrets imported from the ".env" file +$ gh secret set -f .env + +# Set multiple secrets from stdin +$ gh secret set -f - < myfile.txt + +.EE + + +.SH SEE ALSO +\fBgh-secret(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-secret.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-secret.1 new file mode 100644 index 00000000..cd1228dc --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-secret.1 @@ -0,0 +1,56 @@ +.nh +.TH "GH-SECRET" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-secret - Manage GitHub secrets + + +.SH SYNOPSIS +\fBgh secret <command> [flags]\fR + + +.SH DESCRIPTION +Secrets can be set at the repository, or organization level for use in +GitHub Actions or Dependabot. User, organization, and repository secrets can be set for +use in GitHub Codespaces. Environment secrets can be set for use in +GitHub Actions. Run \fBgh help secret set\fR to learn how to get started. + + +.SH AVAILABLE COMMANDS +.TP +\fBgh-secret-delete(1)\fR +Delete secrets + +.TP +\fBgh-secret-list(1)\fR +List secrets + +.TP +\fBgh-secret-set(1)\fR +Create or update secrets + + +.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/gh_2.76.2_macOS_amd64/share/man/man1/gh-ssh-key-add.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-ssh-key-add.1 new file mode 100644 index 00000000..eec1ccf9 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-ssh-key-add.1 @@ -0,0 +1,39 @@ +.nh +.TH "GH-SSH-KEY-ADD" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-ssh-key-add - Add an SSH key to your GitHub account + + +.SH SYNOPSIS +\fBgh ssh-key add [<key-file>] [flags]\fR + + +.SH OPTIONS +.TP +\fB-t\fR, \fB--title\fR \fB<string>\fR +Title for the new key + +.TP +\fB--type\fR \fB<string> (default "authentication")\fR +Type of the ssh key: {authentication|signing} + + +.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-ssh-key(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-ssh-key-delete.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-ssh-key-delete.1 new file mode 100644 index 00000000..084bfa7e --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-ssh-key-delete.1 @@ -0,0 +1,35 @@ +.nh +.TH "GH-SSH-KEY-DELETE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-ssh-key-delete - Delete an SSH key from your GitHub account + + +.SH SYNOPSIS +\fBgh ssh-key delete <id> [flags]\fR + + +.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-ssh-key(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-ssh-key-list.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-ssh-key-list.1 new file mode 100644 index 00000000..cd4726b7 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-ssh-key-list.1 @@ -0,0 +1,33 @@ +.nh +.TH "GH-SSH-KEY-LIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-ssh-key-list - Lists SSH keys in your GitHub account + + +.SH SYNOPSIS +\fBgh ssh-key list [flags]\fR + + +.SH ALIASES +gh ssh-key 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-ssh-key(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-ssh-key.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-ssh-key.1 new file mode 100644 index 00000000..59c63101 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-ssh-key.1 @@ -0,0 +1,47 @@ +.nh +.TH "GH-SSH-KEY" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-ssh-key - Manage SSH keys + + +.SH SYNOPSIS +\fBgh ssh-key <command> [flags]\fR + + +.SH DESCRIPTION +Manage SSH keys registered with your GitHub account. + + +.SH AVAILABLE COMMANDS +.TP +\fBgh-ssh-key-add(1)\fR +Add an SSH key to your GitHub account + +.TP +\fBgh-ssh-key-delete(1)\fR +Delete an SSH key from your GitHub account + +.TP +\fBgh-ssh-key-list(1)\fR +Lists SSH keys in your GitHub account + + +.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/gh_2.76.2_macOS_amd64/share/man/man1/gh-status.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-status.1 new file mode 100644 index 00000000..8d5d311d --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-status.1 @@ -0,0 +1,61 @@ +.nh +.TH "GH-STATUS" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-status - Print information about relevant issues, pull requests, and notifications across repositories + + +.SH SYNOPSIS +\fBgh status [flags]\fR + + +.SH DESCRIPTION +The status command prints information about your work on GitHub across all the repositories you're subscribed to, including: +.IP \(bu 2 +Assigned Issues +.IP \(bu 2 +Assigned Pull Requests +.IP \(bu 2 +Review Requests +.IP \(bu 2 +Mentions +.IP \(bu 2 +Repository Activity (new issues/pull requests, comments) + + +.SH OPTIONS +.TP +\fB-e\fR, \fB--exclude\fR \fB<strings>\fR +Comma separated list of repos to exclude in owner/name format + +.TP +\fB-o\fR, \fB--org\fR \fB<string>\fR +Report status within an organization + + +.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 +$ gh status -e cli/cli -e cli/go-gh # Exclude multiple repositories +$ gh status -o cli # Limit results to a single organization + +.EE + + +.SH SEE ALSO +\fBgh(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-variable-delete.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-variable-delete.1 new file mode 100644 index 00000000..bd7e9299 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-variable-delete.1 @@ -0,0 +1,56 @@ +.nh +.TH "GH-VARIABLE-DELETE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-variable-delete - Delete variables + + +.SH SYNOPSIS +\fBgh variable delete <variable-name> [flags]\fR + + +.SH DESCRIPTION +Delete a variable on one of the following levels: +- repository (default): available to GitHub Actions runs or Dependabot in a repository +- environment: available to GitHub Actions runs for a deployment environment in a repository +- organization: available to GitHub Actions runs or Dependabot within an organization + + +.SH OPTIONS +.TP +\fB-e\fR, \fB--env\fR \fB<string>\fR +Delete a variable for an environment + +.TP +\fB-o\fR, \fB--org\fR \fB<string>\fR +Delete a variable for an organization + + +.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 variable remove + + +.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-variable(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-variable-get.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-variable-get.1 new file mode 100644 index 00000000..5151db20 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-variable-get.1 @@ -0,0 +1,68 @@ +.nh +.TH "GH-VARIABLE-GET" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-variable-get - Get variables + + +.SH SYNOPSIS +\fBgh variable get <variable-name> [flags]\fR + + +.SH DESCRIPTION +Get a variable on one of the following levels: +- repository (default): available to GitHub Actions runs or Dependabot in a repository +- environment: available to GitHub Actions runs for a deployment environment in a repository +- organization: available to GitHub Actions runs or Dependabot within an organization + + +.SH OPTIONS +.TP +\fB-e\fR, \fB--env\fR \fB<string>\fR +Get a variable for an environment + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB<fields>\fR +Output JSON with the specified fields + +.TP +\fB-o\fR, \fB--org\fR \fB<string>\fR +Get a variable for an organization + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\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 +\fBcreatedAt\fR, \fBname\fR, \fBnumSelectedRepos\fR, \fBselectedReposURL\fR, \fBupdatedAt\fR, \fBvalue\fR, \fBvisibility\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-variable(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-variable-list.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-variable-list.1 new file mode 100644 index 00000000..6048386c --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-variable-list.1 @@ -0,0 +1,72 @@ +.nh +.TH "GH-VARIABLE-LIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-variable-list - List variables + + +.SH SYNOPSIS +\fBgh variable list [flags]\fR + + +.SH DESCRIPTION +List variables on one of the following levels: +- repository (default): available to GitHub Actions runs or Dependabot in a repository +- environment: available to GitHub Actions runs for a deployment environment in a repository +- organization: available to GitHub Actions runs or Dependabot within an organization + + +.SH OPTIONS +.TP +\fB-e\fR, \fB--env\fR \fB<string>\fR +List variables for an environment + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB<fields>\fR +Output JSON with the specified fields + +.TP +\fB-o\fR, \fB--org\fR \fB<string>\fR +List variables for an organization + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\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 variable ls + + +.SH JSON FIELDS +\fBcreatedAt\fR, \fBname\fR, \fBnumSelectedRepos\fR, \fBselectedReposURL\fR, \fBupdatedAt\fR, \fBvalue\fR, \fBvisibility\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-variable(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-variable-set.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-variable-set.1 new file mode 100644 index 00000000..bacd3dc4 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-variable-set.1 @@ -0,0 +1,98 @@ +.nh +.TH "GH-VARIABLE-SET" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-variable-set - Create or update variables + + +.SH SYNOPSIS +\fBgh variable set <variable-name> [flags]\fR + + +.SH DESCRIPTION +Set a value for a variable on one of the following levels: +- repository (default): available to GitHub Actions runs or Dependabot in a repository +- environment: available to GitHub Actions runs for a deployment environment in a repository +- organization: available to GitHub Actions runs or Dependabot within an organization + +.PP +Organization variable can optionally be restricted to only be available to +specific repositories. + + +.SH OPTIONS +.TP +\fB-b\fR, \fB--body\fR \fB<string>\fR +The value for the variable (reads from standard input if not specified) + +.TP +\fB-e\fR, \fB--env\fR \fB<environment>\fR +Set deployment environment variable + +.TP +\fB-f\fR, \fB--env-file\fR \fB<file>\fR +Load variable names and values from a dotenv-formatted file + +.TP +\fB-o\fR, \fB--org\fR \fB<organization>\fR +Set organization variable + +.TP +\fB-r\fR, \fB--repos\fR \fB<repositories>\fR +List of repositories that can access an organization variable + +.TP +\fB-v\fR, \fB--visibility\fR \fB<string> (default "private")\fR +Set visibility for an organization variable: {all|private|selected} + + +.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 +# Add variable value for the current repository in an interactive prompt +$ gh variable set MYVARIABLE + +# Read variable value from an environment variable +$ gh variable set MYVARIABLE --body "$ENV_VALUE" + +# Read variable value from a file +$ gh variable set MYVARIABLE < myfile.txt + +# Set variable for a deployment environment in the current repository +$ gh variable set MYVARIABLE --env myenvironment + +# Set organization-level variable visible to both public and private repositories +$ gh variable set MYVARIABLE --org myOrg --visibility all + +# Set organization-level variable visible to specific repositories +$ gh variable set MYVARIABLE --org myOrg --repos repo1,repo2,repo3 + +# Set multiple variables imported from the ".env" file +$ gh variable set -f .env + +.EE + + +.SH SEE ALSO +\fBgh-variable(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-variable.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-variable.1 new file mode 100644 index 00000000..b0148236 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-variable.1 @@ -0,0 +1,58 @@ +.nh +.TH "GH-VARIABLE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-variable - Manage GitHub Actions variables + + +.SH SYNOPSIS +\fBgh variable <command> [flags]\fR + + +.SH DESCRIPTION +Variables can be set at the repository, environment or organization level for use in +GitHub Actions or Dependabot. Run \fBgh help variable set\fR to learn how to get started. + + +.SH AVAILABLE COMMANDS +.TP +\fBgh-variable-delete(1)\fR +Delete variables + +.TP +\fBgh-variable-get(1)\fR +Get variables + +.TP +\fBgh-variable-list(1)\fR +List variables + +.TP +\fBgh-variable-set(1)\fR +Create or update variables + + +.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/gh_2.76.2_macOS_amd64/share/man/man1/gh-workflow-disable.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-workflow-disable.1 new file mode 100644 index 00000000..76b485ff --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-workflow-disable.1 @@ -0,0 +1,39 @@ +.nh +.TH "GH-WORKFLOW-DISABLE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-workflow-disable - Disable a workflow + + +.SH SYNOPSIS +\fBgh workflow disable [<workflow-id> | <workflow-name>] [flags]\fR + + +.SH DESCRIPTION +Disable a workflow, preventing it from running or showing up when listing workflows. + + +.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-workflow(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-workflow-enable.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-workflow-enable.1 new file mode 100644 index 00000000..11ec3bf2 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-workflow-enable.1 @@ -0,0 +1,39 @@ +.nh +.TH "GH-WORKFLOW-ENABLE" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-workflow-enable - Enable a workflow + + +.SH SYNOPSIS +\fBgh workflow enable [<workflow-id> | <workflow-name>] [flags]\fR + + +.SH DESCRIPTION +Enable a workflow, allowing it to be run and show up when listing workflows. + + +.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-workflow(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-workflow-list.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-workflow-list.1 new file mode 100644 index 00000000..66c82eef --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-workflow-list.1 @@ -0,0 +1,69 @@ +.nh +.TH "GH-WORKFLOW-LIST" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-workflow-list - List workflows + + +.SH SYNOPSIS +\fBgh workflow list [flags]\fR + + +.SH DESCRIPTION +List workflow files, hiding disabled workflows by default. + + +.SH OPTIONS +.TP +\fB-a\fR, \fB--all\fR +Include disabled workflows + +.TP +\fB-q\fR, \fB--jq\fR \fB<expression>\fR +Filter JSON output using a jq expression + +.TP +\fB--json\fR \fB<fields>\fR +Output JSON with the specified fields + +.TP +\fB-L\fR, \fB--limit\fR \fB<int> (default 50)\fR +Maximum number of workflows to fetch + +.TP +\fB-t\fR, \fB--template\fR \fB<string>\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 workflow ls + + +.SH JSON FIELDS +\fBid\fR, \fBname\fR, \fBpath\fR, \fBstate\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-workflow(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-workflow-run.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-workflow-run.1 new file mode 100644 index 00000000..476cb805 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-workflow-run.1 @@ -0,0 +1,90 @@ +.nh +.TH "GH-WORKFLOW-RUN" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-workflow-run - Run a workflow by creating a workflow_dispatch event + + +.SH SYNOPSIS +\fBgh workflow run [<workflow-id> | <workflow-name>] [flags]\fR + + +.SH DESCRIPTION +Create a \fBworkflow_dispatch\fR event for a given workflow. + +.PP +This command will trigger GitHub Actions to run a given workflow file. The given workflow file must +support an \fBon.workflow_dispatch\fR trigger in order to be run in this way. + +.PP +If the workflow file supports inputs, they can be specified in a few ways: +.IP \(bu 2 +Interactively +.IP \(bu 2 +Via \fB-f/--raw-field\fR or \fB-F/--field\fR flags +.IP \(bu 2 +As JSON, via standard input + + +.SH OPTIONS +.TP +\fB-F\fR, \fB--field\fR \fB<key=value>\fR +Add a string parameter in key=value format, respecting @ syntax (see "gh help api"). + +.TP +\fB--json\fR +Read workflow inputs as JSON via STDIN + +.TP +\fB-f\fR, \fB--raw-field\fR \fB<key=value>\fR +Add a string parameter in key=value format + +.TP +\fB-r\fR, \fB--ref\fR \fB<string>\fR +Branch or tag name which contains the version of the workflow file you'd like to run + + +.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 +# Have gh prompt you for what workflow you'd like to run and interactively collect inputs +$ gh workflow run + +# Run the workflow file 'triage.yml' at the remote's default branch +$ gh workflow run triage.yml + +# Run the workflow file 'triage.yml' at a specified ref +$ gh workflow run triage.yml --ref my-branch + +# Run the workflow file 'triage.yml' with command line inputs +$ gh workflow run triage.yml -f name=scully -f greeting=hello + +# Run the workflow file 'triage.yml' with JSON via standard input +$ echo '{"name":"scully", "greeting":"hello"}' | gh workflow run triage.yml --json + +.EE + + +.SH SEE ALSO +\fBgh-workflow(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-workflow-view.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-workflow-view.1 new file mode 100644 index 00000000..300666dc --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-workflow-view.1 @@ -0,0 +1,60 @@ +.nh +.TH "GH-WORKFLOW-VIEW" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-workflow-view - View the summary of a workflow + + +.SH SYNOPSIS +\fBgh workflow view [<workflow-id> | <workflow-name> | <filename>] [flags]\fR + + +.SH OPTIONS +.TP +\fB-r\fR, \fB--ref\fR \fB<string>\fR +The branch or tag name which contains the version of the workflow file you'd like to view + +.TP +\fB-w\fR, \fB--web\fR +Open workflow in the browser + +.TP +\fB-y\fR, \fB--yaml\fR +View the workflow yaml file + + +.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 +# Interactively select a workflow to view +$ gh workflow view + +# View a specific workflow +$ gh workflow view 0451 + +.EE + + +.SH SEE ALSO +\fBgh-workflow(1)\fR diff --git a/gh_2.76.2_macOS_amd64/share/man/man1/gh-workflow.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh-workflow.1 new file mode 100644 index 00000000..214a9dfe --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh-workflow.1 @@ -0,0 +1,61 @@ +.nh +.TH "GH-WORKFLOW" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh-workflow - View details about GitHub Actions workflows + + +.SH SYNOPSIS +\fBgh workflow <command> [flags]\fR + + +.SH DESCRIPTION +List, view, and run workflows in GitHub Actions. + + +.SH AVAILABLE COMMANDS +.TP +\fBgh-workflow-disable(1)\fR +Disable a workflow + +.TP +\fBgh-workflow-enable(1)\fR +Enable a workflow + +.TP +\fBgh-workflow-list(1)\fR +List workflows + +.TP +\fBgh-workflow-run(1)\fR +Run a workflow by creating a workflow_dispatch event + +.TP +\fBgh-workflow-view(1)\fR +View the summary of a workflow + + +.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/gh_2.76.2_macOS_amd64/share/man/man1/gh.1 b/gh_2.76.2_macOS_amd64/share/man/man1/gh.1 new file mode 100644 index 00000000..6789ecd4 --- /dev/null +++ b/gh_2.76.2_macOS_amd64/share/man/man1/gh.1 @@ -0,0 +1,162 @@ +.nh +.TH "GH" "1" "Jul 2025" "GitHub CLI 2.76.2" "GitHub CLI manual" + +.SH NAME +gh - GitHub CLI + + +.SH SYNOPSIS +\fBgh <command> <subcommand> [flags]\fR + + +.SH DESCRIPTION +Work seamlessly with GitHub from the command line. + + +.SH CORE COMMANDS +.TP +\fBgh-auth(1)\fR +Authenticate gh and git with GitHub + +.TP +\fBgh-browse(1)\fR +Open repositories, issues, pull requests, and more in the browser + +.TP +\fBgh-codespace(1)\fR +Connect to and manage codespaces + +.TP +\fBgh-gist(1)\fR +Manage gists + +.TP +\fBgh-issue(1)\fR +Manage issues + +.TP +\fBgh-org(1)\fR +Manage organizations + +.TP +\fBgh-pr(1)\fR +Manage pull requests + +.TP +\fBgh-project(1)\fR +Work with GitHub Projects. + +.TP +\fBgh-release(1)\fR +Manage releases + +.TP +\fBgh-repo(1)\fR +Manage repositories + + +.SH GITHUB ACTIONS COMMANDS +.TP +\fBgh-cache(1)\fR +Manage GitHub Actions caches + +.TP +\fBgh-run(1)\fR +View details about workflow runs + +.TP +\fBgh-workflow(1)\fR +View details about GitHub Actions workflows + + +.SH ADDITIONAL COMMANDS +.TP +\fBgh-alias(1)\fR +Create command shortcuts + +.TP +\fBgh-api(1)\fR +Make an authenticated GitHub API request + +.TP +\fBgh-attestation(1)\fR +Work with artifact attestations + +.TP +\fBgh-completion(1)\fR +Generate shell completion scripts + +.TP +\fBgh-config(1)\fR +Manage configuration for gh + +.TP +\fBgh-extension(1)\fR +Manage gh extensions + +.TP +\fBgh-gpg-key(1)\fR +Manage GPG keys + +.TP +\fBgh-label(1)\fR +Manage labels + +.TP +\fBgh-preview(1)\fR +Execute previews for gh features + +.TP +\fBgh-ruleset(1)\fR +View info about repo rulesets + +.TP +\fBgh-search(1)\fR +Search for repositories, issues, and pull requests + +.TP +\fBgh-secret(1)\fR +Manage GitHub secrets + +.TP +\fBgh-ssh-key(1)\fR +Manage SSH keys + +.TP +\fBgh-status(1)\fR +Print information about relevant issues, pull requests, and notifications across repositories + +.TP +\fBgh-variable(1)\fR +Manage GitHub Actions variables + + +.SH OPTIONS +.TP +\fB--version\fR +Show gh version + + +.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 +$ gh issue create +$ gh repo clone cli/cli +$ gh pr checkout 321 + +.EE diff --git a/lib/collections/fake.dart b/lib/collections/fake.dart index 8af40e71..4ed2cdb6 100644 --- a/lib/collections/fake.dart +++ b/lib/collections/fake.dart @@ -1,4 +1,4 @@ -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/models/database/database.dart'; import 'package:spotube/models/spotify/home_feed.dart'; import 'package:spotube/models/spotify_friends.dart'; diff --git a/lib/collections/routes.gr.dart b/lib/collections/routes.gr.dart index 1d608896..74ea2963 100644 --- a/lib/collections/routes.gr.dart +++ b/lib/collections/routes.gr.dart @@ -11,7 +11,6 @@ import 'package:auto_route/auto_route.dart' as _i43; import 'package:flutter/material.dart' as _i44; import 'package:shadcn_flutter/shadcn_flutter.dart' as _i46; -import 'package:spotify/spotify.dart' as _i45; import 'package:spotube/models/spotify/recommendation_seeds.dart' as _i47; import 'package:spotube/pages/album/album.dart' as _i2; import 'package:spotube/pages/artist/artist.dart' as _i3; @@ -59,6 +58,7 @@ import 'package:spotube/pages/stats/playlists/playlists.dart' as _i33; import 'package:spotube/pages/stats/stats.dart' as _i32; import 'package:spotube/pages/stats/streams/streams.dart' as _i35; import 'package:spotube/pages/track/track.dart' as _i36; +import 'package:spotube/platform/spotify/spotify.dart' as _i45; /// generated route for /// [_i1.AboutSpotubePage] diff --git a/lib/collections/spotify_markets.dart b/lib/collections/spotify_markets.dart index 514b3f0b..27ab0bbb 100644 --- a/lib/collections/spotify_markets.dart +++ b/lib/collections/spotify_markets.dart @@ -1,6 +1,6 @@ // Country Codes contributed by momobobe <https://github.com/momobobe> -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; final spotifyMarkets = [ (Market.AL, "Albania (AL)"), diff --git a/lib/components/dialogs/playlist_add_track_dialog.dart b/lib/components/dialogs/playlist_add_track_dialog.dart index 5098bf9d..e8403039 100644 --- a/lib/components/dialogs/playlist_add_track_dialog.dart +++ b/lib/components/dialogs/playlist_add_track_dialog.dart @@ -2,7 +2,7 @@ import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/modules/playlist/playlist_create_dialog.dart'; import 'package:spotube/components/image/universal_image.dart'; import 'package:spotube/extensions/context.dart'; diff --git a/lib/components/dialogs/replace_downloaded_dialog.dart b/lib/components/dialogs/replace_downloaded_dialog.dart index 3a0f3a1d..2d02f3d1 100644 --- a/lib/components/dialogs/replace_downloaded_dialog.dart +++ b/lib/components/dialogs/replace_downloaded_dialog.dart @@ -1,7 +1,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/extensions/context.dart'; final replaceDownloadedFileState = StateProvider<bool?>((ref) => null); diff --git a/lib/components/dialogs/track_details_dialog.dart b/lib/components/dialogs/track_details_dialog.dart index bfb4a318..dd7a2699 100644 --- a/lib/components/dialogs/track_details_dialog.dart +++ b/lib/components/dialogs/track_details_dialog.dart @@ -1,6 +1,6 @@ import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/routes.gr.dart'; import 'package:spotube/collections/spotube_icons.dart'; import 'package:spotube/components/links/artist_link.dart'; diff --git a/lib/components/heart_button/heart_button.dart b/lib/components/heart_button/heart_button.dart index 275d5db1..f870061e 100644 --- a/lib/components/heart_button/heart_button.dart +++ b/lib/components/heart_button/heart_button.dart @@ -1,7 +1,7 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/components/heart_button/use_track_toggle_like.dart'; import 'package:spotube/extensions/context.dart'; import 'package:spotube/provider/authentication/authentication.dart'; diff --git a/lib/components/heart_button/use_track_toggle_like.dart b/lib/components/heart_button/use_track_toggle_like.dart index ba5cbee1..5313a2ec 100644 --- a/lib/components/heart_button/use_track_toggle_like.dart +++ b/lib/components/heart_button/use_track_toggle_like.dart @@ -1,6 +1,6 @@ import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/provider/scrobbler/scrobbler.dart'; import 'package:spotube/provider/spotify/spotify.dart'; diff --git a/lib/components/horizontal_playbutton_card_view/horizontal_playbutton_card_view.dart b/lib/components/horizontal_playbutton_card_view/horizontal_playbutton_card_view.dart index 47fb0f33..c87f3b47 100644 --- a/lib/components/horizontal_playbutton_card_view/horizontal_playbutton_card_view.dart +++ b/lib/components/horizontal_playbutton_card_view/horizontal_playbutton_card_view.dart @@ -4,7 +4,7 @@ import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; import 'package:shadcn_flutter/shadcn_flutter_extension.dart'; import 'package:skeletonizer/skeletonizer.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/fake.dart'; import 'package:spotube/modules/album/album_card.dart'; import 'package:spotube/modules/artist/artist_card.dart'; diff --git a/lib/components/links/artist_link.dart b/lib/components/links/artist_link.dart index 9467cb38..2be462e4 100644 --- a/lib/components/links/artist_link.dart +++ b/lib/components/links/artist_link.dart @@ -1,6 +1,6 @@ import 'package:auto_route/auto_route.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/routes.gr.dart'; import 'package:spotube/components/links/anchor_button.dart'; import 'package:spotube/extensions/context.dart'; diff --git a/lib/components/titlebar/titlebar.dart b/lib/components/titlebar/titlebar.dart index 778f0b09..a9b99482 100644 --- a/lib/components/titlebar/titlebar.dart +++ b/lib/components/titlebar/titlebar.dart @@ -7,7 +7,7 @@ import 'package:spotube/components/button/back_button.dart'; import 'package:spotube/components/titlebar/titlebar_buttons.dart'; import 'package:spotube/provider/user_preferences/user_preferences_provider.dart'; import 'package:spotube/utils/platform.dart'; -import 'package:window_manager/window_manager.dart'; +import 'package:spotube/platform/window_manager/window_manager.dart'; final kTitlebarVisible = kIsWindows || kIsLinux; diff --git a/lib/components/titlebar/titlebar_buttons.dart b/lib/components/titlebar/titlebar_buttons.dart index 30d88508..fe3eddcd 100644 --- a/lib/components/titlebar/titlebar_buttons.dart +++ b/lib/components/titlebar/titlebar_buttons.dart @@ -10,7 +10,7 @@ import 'package:spotube/hooks/configurators/use_window_listener.dart'; import 'package:spotube/provider/user_preferences/user_preferences_provider.dart'; import 'package:spotube/utils/platform.dart'; import 'package:titlebar_buttons/titlebar_buttons.dart'; -import 'package:window_manager/window_manager.dart'; +import 'package:spotube/platform/window_manager/window_manager.dart'; class WindowTitleBarButtons extends HookConsumerWidget { final Color? foregroundColor; diff --git a/lib/components/track_presentation/presentation_actions.dart b/lib/components/track_presentation/presentation_actions.dart index bbeb90a5..6653c039 100644 --- a/lib/components/track_presentation/presentation_actions.dart +++ b/lib/components/track_presentation/presentation_actions.dart @@ -1,7 +1,7 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; import 'package:shadcn_flutter/shadcn_flutter_extension.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/spotube_icons.dart'; import 'package:spotube/components/adaptive/adaptive_pop_sheet_list.dart'; import 'package:spotube/components/dialogs/confirm_download_dialog.dart'; diff --git a/lib/components/track_presentation/presentation_props.dart b/lib/components/track_presentation/presentation_props.dart index 144cf0e8..faf25b5c 100644 --- a/lib/components/track_presentation/presentation_props.dart +++ b/lib/components/track_presentation/presentation_props.dart @@ -1,7 +1,7 @@ import 'dart:async'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; class PaginationProps { final bool hasNextPage; diff --git a/lib/components/track_presentation/presentation_state.dart b/lib/components/track_presentation/presentation_state.dart index d3428861..937a4902 100644 --- a/lib/components/track_presentation/presentation_state.dart +++ b/lib/components/track_presentation/presentation_state.dart @@ -1,7 +1,7 @@ import 'package:collection/collection.dart'; import 'package:fuzzywuzzy/fuzzywuzzy.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/pages/library/user_local_tracks/user_local_tracks.dart'; import 'package:spotube/provider/spotify/spotify.dart'; import 'package:spotube/utils/service_utils.dart'; diff --git a/lib/components/track_presentation/presentation_top.dart b/lib/components/track_presentation/presentation_top.dart index 5935fa13..34a1d8d3 100644 --- a/lib/components/track_presentation/presentation_top.dart +++ b/lib/components/track_presentation/presentation_top.dart @@ -3,7 +3,7 @@ import 'package:flutter/services.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; import 'package:shadcn_flutter/shadcn_flutter_extension.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/env.dart'; import 'package:spotube/collections/spotube_icons.dart'; import 'package:spotube/components/heart_button/heart_button.dart'; diff --git a/lib/components/track_presentation/use_action_callbacks.dart b/lib/components/track_presentation/use_action_callbacks.dart index 0012594a..3fd47816 100644 --- a/lib/components/track_presentation/use_action_callbacks.dart +++ b/lib/components/track_presentation/use_action_callbacks.dart @@ -2,7 +2,7 @@ import 'dart:math'; import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/components/dialogs/select_device_dialog.dart'; import 'package:spotube/components/track_presentation/presentation_props.dart'; diff --git a/lib/components/track_presentation/use_track_tile_play_callback.dart b/lib/components/track_presentation/use_track_tile_play_callback.dart index b519f781..e4bef3d8 100644 --- a/lib/components/track_presentation/use_track_tile_play_callback.dart +++ b/lib/components/track_presentation/use_track_tile_play_callback.dart @@ -1,7 +1,7 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:flutter_hooks/flutter_hooks.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/components/dialogs/select_device_dialog.dart'; import 'package:spotube/components/track_presentation/presentation_props.dart'; import 'package:spotube/components/track_presentation/presentation_state.dart'; diff --git a/lib/components/track_tile/track_options.dart b/lib/components/track_tile/track_options.dart index a0738165..1d3c171e 100644 --- a/lib/components/track_tile/track_options.dart +++ b/lib/components/track_tile/track_options.dart @@ -8,7 +8,7 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; import 'package:shadcn_flutter/shadcn_flutter_extension.dart'; -import 'package:spotify/spotify.dart' hide Offset; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/assets.gen.dart'; import 'package:spotube/collections/routes.gr.dart'; import 'package:spotube/collections/spotube_icons.dart'; diff --git a/lib/components/track_tile/track_tile.dart b/lib/components/track_tile/track_tile.dart index f47980cd..f48d6a3d 100644 --- a/lib/components/track_tile/track_tile.dart +++ b/lib/components/track_tile/track_tile.dart @@ -7,7 +7,7 @@ import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart' hide Consumer; import 'package:skeletonizer/skeletonizer.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/routes.gr.dart'; import 'package:spotube/collections/spotube_icons.dart'; import 'package:spotube/components/hover_builder.dart'; diff --git a/lib/core/flags.dart b/lib/core/flags.dart new file mode 100644 index 00000000..eefffe29 --- /dev/null +++ b/lib/core/flags.dart @@ -0,0 +1,4 @@ +class Flags { + static const disableSpotify = + bool.fromEnvironment('DISABLE_SPOTIFY', defaultValue: true); +} diff --git a/lib/extensions/album_simple.dart b/lib/extensions/album_simple.dart index 5678390c..fd067977 100644 --- a/lib/extensions/album_simple.dart +++ b/lib/extensions/album_simple.dart @@ -1,4 +1,4 @@ -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; extension AlbumExtensions on AlbumSimple { Album toAlbum() { diff --git a/lib/extensions/artist_simple.dart b/lib/extensions/artist_simple.dart index 7997355d..e03f7c17 100644 --- a/lib/extensions/artist_simple.dart +++ b/lib/extensions/artist_simple.dart @@ -1,4 +1,4 @@ -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; extension ArtistExtension on List<ArtistSimple> { String asString() { diff --git a/lib/extensions/image.dart b/lib/extensions/image.dart index ee78653a..8be4f813 100644 --- a/lib/extensions/image.dart +++ b/lib/extensions/image.dart @@ -1,4 +1,4 @@ -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/assets.gen.dart'; import 'package:spotube/utils/primitive_utils.dart'; import 'package:collection/collection.dart'; diff --git a/lib/extensions/track.dart b/lib/extensions/track.dart index 92d8b0da..0a43cf1f 100644 --- a/lib/extensions/track.dart +++ b/lib/extensions/track.dart @@ -1,9 +1,9 @@ import 'dart:io'; import 'dart:typed_data'; -import 'package:metadata_god/metadata_god.dart'; +import 'package:spotube/platform/metadata/metadata.dart'; import 'package:path/path.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/provider/spotify/spotify.dart'; import 'package:spotube/services/audio_player/audio_player.dart'; import 'package:spotube/services/logger/logger.dart'; diff --git a/lib/generated_plugin_registrant.dart b/lib/generated_plugin_registrant.dart deleted file mode 100644 index a25a1f5f..00000000 --- a/lib/generated_plugin_registrant.dart +++ /dev/null @@ -1,23 +0,0 @@ -// -// Generated file. Do not edit. -// - -// ignore_for_file: directives_ordering -// ignore_for_file: lines_longer_than_80_chars -// ignore_for_file: depend_on_referenced_packages - -import 'package:audio_service_web/audio_service_web.dart'; -import 'package:audio_session/audio_session_web.dart'; -import 'package:shared_preferences_web/shared_preferences_web.dart'; -import 'package:url_launcher_web/url_launcher_web.dart'; - -import 'package:flutter_web_plugins/flutter_web_plugins.dart'; - -// ignore: public_member_api_docs -void registerPlugins(Registrar registrar) { - AudioServiceWeb.registerWith(registrar); - AudioSessionWeb.registerWith(registrar); - SharedPreferencesPlugin.registerWith(registrar); - UrlLauncherPlugin.registerWith(registrar); - registrar.registerMessageHandler(); -} diff --git a/lib/hooks/configurators/use_close_behavior.dart b/lib/hooks/configurators/use_close_behavior.dart index 2bdc65ef..463bf786 100644 --- a/lib/hooks/configurators/use_close_behavior.dart +++ b/lib/hooks/configurators/use_close_behavior.dart @@ -7,7 +7,7 @@ import 'package:spotube/provider/user_preferences/user_preferences_provider.dart import 'package:local_notifier/local_notifier.dart'; import 'package:spotube/utils/platform.dart'; -import 'package:window_manager/window_manager.dart'; +import 'package:spotube/platform/window_manager/window_manager.dart'; final closeNotification = !kIsDesktop ? null diff --git a/lib/hooks/configurators/use_endless_playback.dart b/lib/hooks/configurators/use_endless_playback.dart index b86a4865..f13d47cf 100644 --- a/lib/hooks/configurators/use_endless_playback.dart +++ b/lib/hooks/configurators/use_endless_playback.dart @@ -1,7 +1,7 @@ import 'package:spotube/services/logger/logger.dart'; import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/provider/authentication/authentication.dart'; import 'package:spotube/provider/audio_player/audio_player.dart'; import 'package:spotube/provider/spotify/spotify.dart'; diff --git a/lib/hooks/configurators/use_fix_window_stretching.dart b/lib/hooks/configurators/use_fix_window_stretching.dart index b94098ab..e4c2ce56 100644 --- a/lib/hooks/configurators/use_fix_window_stretching.dart +++ b/lib/hooks/configurators/use_fix_window_stretching.dart @@ -1,7 +1,7 @@ import 'package:shadcn_flutter/shadcn_flutter.dart'; import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:spotube/utils/platform.dart'; -import 'package:window_manager/window_manager.dart'; +import 'package:spotube/platform/window_manager/window_manager.dart'; void useFixWindowStretching() { useEffect(() { diff --git a/lib/hooks/configurators/use_window_listener.dart b/lib/hooks/configurators/use_window_listener.dart index 5977ea8e..1d90d6fd 100644 --- a/lib/hooks/configurators/use_window_listener.dart +++ b/lib/hooks/configurators/use_window_listener.dart @@ -2,7 +2,7 @@ import 'package:flutter/widgets.dart'; import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:spotube/utils/platform.dart'; -import 'package:window_manager/window_manager.dart'; +import 'package:spotube/platform/window_manager/window_manager.dart'; class CallbackWindowListener implements WindowListener { final VoidCallback? _onWindowClose; diff --git a/lib/main.dart b/lib/main.dart index f178b663..5e71aaeb 100644 --- a/lib/main.dart +++ b/lib/main.dart @@ -5,7 +5,6 @@ import 'package:desktop_webview_window/desktop_webview_window.dart'; import 'package:flutter/foundation.dart'; import 'package:flutter/material.dart' as material; import 'package:flutter/services.dart'; -import 'package:flutter_discord_rpc/flutter_discord_rpc.dart'; import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:flutter_localizations/flutter_localizations.dart'; @@ -13,8 +12,8 @@ import 'package:home_widget/home_widget.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:local_notifier/local_notifier.dart'; import 'package:media_kit/media_kit.dart'; -import 'package:metadata_god/metadata_god.dart'; -import 'package:smtc_windows/smtc_windows.dart'; +import 'package:spotube/platform/metadata/metadata.dart'; +import 'package:spotube/platform/media_controls/media_controls.dart'; import 'package:spotube/collections/env.dart'; import 'package:spotube/collections/initializers.dart'; import 'package:spotube/collections/intents.dart'; @@ -47,7 +46,7 @@ import 'package:spotube/utils/platform.dart'; import 'package:flutter_native_splash/flutter_native_splash.dart'; import 'package:flutter_displaymode/flutter_displaymode.dart'; import 'package:timezone/data/latest.dart' as tz; -import 'package:window_manager/window_manager.dart'; +import 'package:spotube/platform/window_manager/window_manager.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; import 'package:yt_dlp_dart/yt_dlp_dart.dart'; import 'package:flutter_new_pipe_extractor/flutter_new_pipe_extractor.dart'; diff --git a/lib/models/connect/connect.dart b/lib/models/connect/connect.dart index a70520ad..eb35bf2a 100644 --- a/lib/models/connect/connect.dart +++ b/lib/models/connect/connect.dart @@ -5,7 +5,7 @@ import 'dart:convert'; import 'package:freezed_annotation/freezed_annotation.dart'; import 'package:media_kit/media_kit.dart' hide Track; -import 'package:spotify/spotify.dart' hide Playlist; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/provider/audio_player/state.dart'; part 'connect.freezed.dart'; diff --git a/lib/models/current_playlist.dart b/lib/models/current_playlist.dart index 7e55e393..383dd118 100644 --- a/lib/models/current_playlist.dart +++ b/lib/models/current_playlist.dart @@ -1,5 +1,5 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/services/sourced_track/sourced_track.dart'; class CurrentPlaylist { diff --git a/lib/models/database/database.dart b/lib/models/database/database.dart index 7cadca37..98f0ef42 100644 --- a/lib/models/database/database.dart +++ b/lib/models/database/database.dart @@ -6,7 +6,7 @@ import 'package:drift/drift.dart'; import 'package:encrypt/encrypt.dart'; import 'package:media_kit/media_kit.dart' hide Track; import 'package:shadcn_flutter/shadcn_flutter.dart' show ThemeMode, Colors; -import 'package:spotify/spotify.dart' hide Playlist; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/models/database/database.steps.dart'; import 'package:spotube/models/lyrics.dart'; import 'package:spotube/services/kv_store/encrypted_kv_store.dart'; diff --git a/lib/models/database/database.steps.dart b/lib/models/database/database.steps.dart index 3e416ea5..484c038f 100644 --- a/lib/models/database/database.steps.dart +++ b/lib/models/database/database.steps.dart @@ -3,7 +3,7 @@ import 'package:drift/internal/versioned_schema.dart' as i0; import 'package:drift/drift.dart' as i1; import 'package:drift/drift.dart'; // ignore_for_file: type=lint,unused_import import 'package:flutter/material.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/models/database/database.dart'; import 'package:spotube/services/sourced_track/enums.dart'; diff --git a/lib/models/local_track.dart b/lib/models/local_track.dart index def3b64f..b378c796 100644 --- a/lib/models/local_track.dart +++ b/lib/models/local_track.dart @@ -1,4 +1,4 @@ -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; class LocalTrack extends Track { final String path; diff --git a/lib/models/spotify/home_feed.dart b/lib/models/spotify/home_feed.dart index ad764304..814f59a6 100644 --- a/lib/models/spotify/home_feed.dart +++ b/lib/models/spotify/home_feed.dart @@ -1,5 +1,5 @@ import 'package:freezed_annotation/freezed_annotation.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; part 'home_feed.freezed.dart'; part 'home_feed.g.dart'; diff --git a/lib/modules/album/album_card.dart b/lib/modules/album/album_card.dart index 5fee9cc4..c933a1e0 100644 --- a/lib/modules/album/album_card.dart +++ b/lib/modules/album/album_card.dart @@ -2,7 +2,7 @@ import 'package:auto_route/auto_route.dart'; import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/routes.gr.dart'; import 'package:spotube/components/dialogs/select_device_dialog.dart'; import 'package:spotube/components/playbutton_view/playbutton_card.dart'; diff --git a/lib/modules/artist/artist_album_list.dart b/lib/modules/artist/artist_album_list.dart index 7131aa3b..c2378b4d 100644 --- a/lib/modules/artist/artist_album_list.dart +++ b/lib/modules/artist/artist_album_list.dart @@ -1,6 +1,6 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/components/horizontal_playbutton_card_view/horizontal_playbutton_card_view.dart'; import 'package:spotube/extensions/context.dart'; import 'package:spotube/provider/spotify/spotify.dart'; diff --git a/lib/modules/artist/artist_card.dart b/lib/modules/artist/artist_card.dart index e53070ef..d152ef8c 100644 --- a/lib/modules/artist/artist_card.dart +++ b/lib/modules/artist/artist_card.dart @@ -4,7 +4,7 @@ import 'package:auto_size_text/auto_size_text.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/routes.gr.dart'; import 'package:spotube/components/image/universal_image.dart'; import 'package:spotube/extensions/context.dart'; diff --git a/lib/modules/home/sections/featured.dart b/lib/modules/home/sections/featured.dart index a339bd43..c8a949fd 100644 --- a/lib/modules/home/sections/featured.dart +++ b/lib/modules/home/sections/featured.dart @@ -3,7 +3,7 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; import 'package:shadcn_flutter/shadcn_flutter_extension.dart'; import 'package:skeletonizer/skeletonizer.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/components/horizontal_playbutton_card_view/horizontal_playbutton_card_view.dart'; import 'package:spotube/extensions/context.dart'; import 'package:spotube/provider/spotify/spotify.dart'; diff --git a/lib/modules/home/sections/genres/genre_card.dart b/lib/modules/home/sections/genres/genre_card.dart index 8133f0db..0648a8e6 100644 --- a/lib/modules/home/sections/genres/genre_card.dart +++ b/lib/modules/home/sections/genres/genre_card.dart @@ -5,7 +5,7 @@ import 'package:auto_route/auto_route.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; import 'package:skeletonizer/skeletonizer.dart'; -import 'package:spotify/spotify.dart' hide Offset; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/fake.dart'; import 'package:spotube/collections/gradients.dart'; import 'package:spotube/collections/routes.gr.dart'; diff --git a/lib/modules/home/sections/genres/genre_card_playlist_card.dart b/lib/modules/home/sections/genres/genre_card_playlist_card.dart index 328507cc..f4c5939d 100644 --- a/lib/modules/home/sections/genres/genre_card_playlist_card.dart +++ b/lib/modules/home/sections/genres/genre_card_playlist_card.dart @@ -1,7 +1,7 @@ import 'package:auto_route/auto_route.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart' hide Consumer; -import 'package:spotify/spotify.dart' hide Image; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/env.dart'; import 'package:spotube/collections/routes.gr.dart'; import 'package:spotube/components/image/universal_image.dart'; diff --git a/lib/modules/home/sections/made_for_user.dart b/lib/modules/home/sections/made_for_user.dart index 4fd025d5..927c950a 100644 --- a/lib/modules/home/sections/made_for_user.dart +++ b/lib/modules/home/sections/made_for_user.dart @@ -1,6 +1,6 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/components/horizontal_playbutton_card_view/horizontal_playbutton_card_view.dart'; import 'package:spotube/provider/spotify/spotify.dart'; diff --git a/lib/modules/home/sections/new_releases.dart b/lib/modules/home/sections/new_releases.dart index 2ebbbee0..097ee746 100644 --- a/lib/modules/home/sections/new_releases.dart +++ b/lib/modules/home/sections/new_releases.dart @@ -1,6 +1,6 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/components/horizontal_playbutton_card_view/horizontal_playbutton_card_view.dart'; import 'package:spotube/extensions/context.dart'; import 'package:spotube/provider/authentication/authentication.dart'; diff --git a/lib/modules/library/playlist_generate/simple_track_tile.dart b/lib/modules/library/playlist_generate/simple_track_tile.dart index afa723f3..3f5f8729 100644 --- a/lib/modules/library/playlist_generate/simple_track_tile.dart +++ b/lib/modules/library/playlist_generate/simple_track_tile.dart @@ -1,6 +1,6 @@ import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/spotube_icons.dart'; import 'package:spotube/components/image/universal_image.dart'; diff --git a/lib/modules/library/user_downloads/download_item.dart b/lib/modules/library/user_downloads/download_item.dart index 2c0a96a5..64bc3411 100644 --- a/lib/modules/library/user_downloads/download_item.dart +++ b/lib/modules/library/user_downloads/download_item.dart @@ -2,7 +2,7 @@ import 'package:auto_route/auto_route.dart'; import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/routes.gr.dart'; import 'package:spotube/collections/spotube_icons.dart'; import 'package:spotube/components/image/universal_image.dart'; diff --git a/lib/modules/player/player_queue.dart b/lib/modules/player/player_queue.dart index 06d7e3c7..c4fccdcc 100644 --- a/lib/modules/player/player_queue.dart +++ b/lib/modules/player/player_queue.dart @@ -7,7 +7,7 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:scroll_to_index/scroll_to_index.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/spotube_icons.dart'; import 'package:spotube/components/button/back_button.dart'; import 'package:spotube/components/fallbacks/not_found.dart'; diff --git a/lib/modules/player/player_track_details.dart b/lib/modules/player/player_track_details.dart index 2e38bf37..e76235e4 100644 --- a/lib/modules/player/player_track_details.dart +++ b/lib/modules/player/player_track_details.dart @@ -2,7 +2,7 @@ import 'package:auto_route/auto_route.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/assets.gen.dart'; import 'package:spotube/collections/routes.gr.dart'; diff --git a/lib/modules/playlist/playlist_card.dart b/lib/modules/playlist/playlist_card.dart index c4ffffa7..7fa68e30 100644 --- a/lib/modules/playlist/playlist_card.dart +++ b/lib/modules/playlist/playlist_card.dart @@ -2,7 +2,7 @@ import 'package:auto_route/auto_route.dart'; import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart' hide Consumer; -import 'package:spotify/spotify.dart' hide Offset, Image; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/env.dart'; import 'package:spotube/collections/routes.gr.dart'; import 'package:spotube/components/dialogs/select_device_dialog.dart'; diff --git a/lib/modules/playlist/playlist_create_dialog.dart b/lib/modules/playlist/playlist_create_dialog.dart index 3ee39583..ef3f8bc6 100644 --- a/lib/modules/playlist/playlist_create_dialog.dart +++ b/lib/modules/playlist/playlist_create_dialog.dart @@ -10,7 +10,7 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:image_picker/image_picker.dart'; import 'package:path/path.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/spotube_icons.dart'; import 'package:spotube/components/form/checkbox_form_field.dart'; diff --git a/lib/modules/root/bottom_player.dart b/lib/modules/root/bottom_player.dart index c2e6369d..38f7af64 100644 --- a/lib/modules/root/bottom_player.dart +++ b/lib/modules/root/bottom_player.dart @@ -21,7 +21,7 @@ import 'package:spotube/provider/user_preferences/user_preferences_provider.dart import 'package:spotube/provider/volume_provider.dart'; import 'package:spotube/utils/platform.dart'; -import 'package:window_manager/window_manager.dart'; +import 'package:spotube/platform/window_manager/window_manager.dart'; class BottomPlayer extends HookConsumerWidget { const BottomPlayer({super.key}); diff --git a/lib/modules/stats/common/album_item.dart b/lib/modules/stats/common/album_item.dart index cd0a6caf..267cedf1 100644 --- a/lib/modules/stats/common/album_item.dart +++ b/lib/modules/stats/common/album_item.dart @@ -1,6 +1,6 @@ import 'package:auto_route/auto_route.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/routes.gr.dart'; import 'package:spotube/components/ui/button_tile.dart'; import 'package:spotube/modules/album/album_card.dart'; diff --git a/lib/modules/stats/common/artist_item.dart b/lib/modules/stats/common/artist_item.dart index 5eff9a9d..fa6f68d1 100644 --- a/lib/modules/stats/common/artist_item.dart +++ b/lib/modules/stats/common/artist_item.dart @@ -1,6 +1,6 @@ import 'package:auto_route/auto_route.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/routes.gr.dart'; import 'package:spotube/components/image/universal_image.dart'; import 'package:spotube/components/ui/button_tile.dart'; diff --git a/lib/modules/stats/common/playlist_item.dart b/lib/modules/stats/common/playlist_item.dart index 58610af1..6bf38c93 100644 --- a/lib/modules/stats/common/playlist_item.dart +++ b/lib/modules/stats/common/playlist_item.dart @@ -1,6 +1,6 @@ import 'package:auto_route/auto_route.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/routes.gr.dart'; import 'package:spotube/components/image/universal_image.dart'; import 'package:spotube/components/ui/button_tile.dart'; diff --git a/lib/modules/stats/common/track_item.dart b/lib/modules/stats/common/track_item.dart index ae2e22c6..39b64670 100644 --- a/lib/modules/stats/common/track_item.dart +++ b/lib/modules/stats/common/track_item.dart @@ -1,6 +1,6 @@ import 'package:auto_route/auto_route.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/routes.gr.dart'; import 'package:spotube/components/image/universal_image.dart'; import 'package:spotube/components/links/artist_link.dart'; diff --git a/lib/pages/album/album.dart b/lib/pages/album/album.dart index 5773f9fa..b1c7119e 100644 --- a/lib/pages/album/album.dart +++ b/lib/pages/album/album.dart @@ -2,7 +2,7 @@ import 'package:flutter/material.dart' as material; import 'package:auto_route/auto_route.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/components/track_presentation/presentation_props.dart'; import 'package:spotube/components/track_presentation/track_presentation.dart'; import 'package:spotube/extensions/context.dart'; diff --git a/lib/pages/artist/section/footer.dart b/lib/pages/artist/section/footer.dart index 9a1423b5..a7a22c38 100644 --- a/lib/pages/artist/section/footer.dart +++ b/lib/pages/artist/section/footer.dart @@ -1,7 +1,7 @@ import 'package:flutter/gestures.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/spotube_icons.dart'; import 'package:spotube/components/image/universal_image.dart'; import 'package:spotube/extensions/constrains.dart'; diff --git a/lib/pages/artist/section/top_tracks.dart b/lib/pages/artist/section/top_tracks.dart index 72709751..2e546925 100644 --- a/lib/pages/artist/section/top_tracks.dart +++ b/lib/pages/artist/section/top_tracks.dart @@ -1,7 +1,7 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; import 'package:skeletonizer/skeletonizer.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/fake.dart'; import 'package:spotube/collections/spotube_icons.dart'; import 'package:spotube/components/dialogs/select_device_dialog.dart'; diff --git a/lib/pages/getting_started/sections/region.dart b/lib/pages/getting_started/sections/region.dart index f657f9d9..372f405f 100644 --- a/lib/pages/getting_started/sections/region.dart +++ b/lib/pages/getting_started/sections/region.dart @@ -1,6 +1,6 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/language_codes.dart'; import 'package:spotube/collections/spotify_markets.dart'; import 'package:spotube/collections/spotube_icons.dart'; diff --git a/lib/pages/home/genres/genre_playlists.dart b/lib/pages/home/genres/genre_playlists.dart index ea421cb4..1da9d8a4 100644 --- a/lib/pages/home/genres/genre_playlists.dart +++ b/lib/pages/home/genres/genre_playlists.dart @@ -5,7 +5,7 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; import 'package:shadcn_flutter/shadcn_flutter_extension.dart'; -import 'package:spotify/spotify.dart' hide Offset; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/routes.gr.dart'; import 'package:spotube/components/button/back_button.dart'; import 'package:spotube/components/playbutton_view/playbutton_view.dart'; diff --git a/lib/pages/library/playlist_generate/playlist_generate.dart b/lib/pages/library/playlist_generate/playlist_generate.dart index f1eca306..1d9809b3 100644 --- a/lib/pages/library/playlist_generate/playlist_generate.dart +++ b/lib/pages/library/playlist_generate/playlist_generate.dart @@ -4,7 +4,7 @@ import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/routes.gr.dart'; import 'package:spotube/collections/spotify_markets.dart'; import 'package:spotube/collections/spotube_icons.dart'; diff --git a/lib/pages/library/playlist_generate/playlist_generate_result.dart b/lib/pages/library/playlist_generate/playlist_generate_result.dart index 9e6f2987..9659e657 100644 --- a/lib/pages/library/playlist_generate/playlist_generate_result.dart +++ b/lib/pages/library/playlist_generate/playlist_generate_result.dart @@ -3,7 +3,7 @@ import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/routes.gr.dart'; import 'package:spotube/collections/spotube_icons.dart'; import 'package:spotube/components/button/back_button.dart'; diff --git a/lib/pages/library/user_playlists.dart b/lib/pages/library/user_playlists.dart index 8b9e0dc3..3c65ff62 100644 --- a/lib/pages/library/user_playlists.dart +++ b/lib/pages/library/user_playlists.dart @@ -6,7 +6,7 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart' hide Image; import 'package:shadcn_flutter/shadcn_flutter_extension.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/routes.gr.dart'; import 'package:spotube/collections/spotube_icons.dart'; import 'package:spotube/components/playbutton_view/playbutton_view.dart'; diff --git a/lib/pages/lyrics/mini_lyrics.dart b/lib/pages/lyrics/mini_lyrics.dart index 4c28eddd..cac397ab 100644 --- a/lib/pages/lyrics/mini_lyrics.dart +++ b/lib/pages/lyrics/mini_lyrics.dart @@ -14,7 +14,7 @@ import 'package:spotube/pages/lyrics/plain_lyrics.dart'; import 'package:spotube/pages/lyrics/synced_lyrics.dart'; import 'package:spotube/provider/audio_player/audio_player.dart'; import 'package:spotube/utils/platform.dart'; -import 'package:window_manager/window_manager.dart'; +import 'package:spotube/platform/window_manager/window_manager.dart'; import 'package:auto_route/auto_route.dart'; @RoutePage() diff --git a/lib/pages/playlist/liked_playlist.dart b/lib/pages/playlist/liked_playlist.dart index 5f7591ab..ab5c976d 100644 --- a/lib/pages/playlist/liked_playlist.dart +++ b/lib/pages/playlist/liked_playlist.dart @@ -1,7 +1,7 @@ import 'package:flutter/material.dart' as material; import 'package:flutter/widgets.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/components/track_presentation/presentation_props.dart'; import 'package:spotube/components/track_presentation/track_presentation.dart'; import 'package:spotube/pages/playlist/playlist.dart'; diff --git a/lib/pages/playlist/playlist.dart b/lib/pages/playlist/playlist.dart index 62ced353..6e686ba6 100644 --- a/lib/pages/playlist/playlist.dart +++ b/lib/pages/playlist/playlist.dart @@ -2,7 +2,7 @@ import 'package:flutter/material.dart' as material; import 'package:collection/collection.dart'; import 'package:flutter/material.dart' hide Page; import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/components/dialogs/prompt_dialog.dart'; import 'package:spotube/components/track_presentation/presentation_props.dart'; import 'package:spotube/components/track_presentation/track_presentation.dart'; diff --git a/lib/pages/search/search.dart b/lib/pages/search/search.dart index 25fb046a..f4b6560a 100644 --- a/lib/pages/search/search.dart +++ b/lib/pages/search/search.dart @@ -2,7 +2,7 @@ import 'package:flutter/services.dart'; import 'package:flutter_undraw/flutter_undraw.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:fuzzywuzzy/fuzzywuzzy.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; diff --git a/lib/pages/search/sections/albums.dart b/lib/pages/search/sections/albums.dart index 105c23d5..c44d69da 100644 --- a/lib/pages/search/sections/albums.dart +++ b/lib/pages/search/sections/albums.dart @@ -2,7 +2,7 @@ import 'package:flutter_hooks/flutter_hooks.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/components/horizontal_playbutton_card_view/horizontal_playbutton_card_view.dart'; import 'package:spotube/extensions/album_simple.dart'; import 'package:spotube/extensions/context.dart'; diff --git a/lib/pages/search/sections/artists.dart b/lib/pages/search/sections/artists.dart index 9a94b3c1..3d917585 100644 --- a/lib/pages/search/sections/artists.dart +++ b/lib/pages/search/sections/artists.dart @@ -1,7 +1,7 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/components/horizontal_playbutton_card_view/horizontal_playbutton_card_view.dart'; import 'package:spotube/extensions/context.dart'; import 'package:spotube/provider/spotify/spotify.dart'; diff --git a/lib/pages/search/sections/playlists.dart b/lib/pages/search/sections/playlists.dart index 17bf4849..55fb55be 100644 --- a/lib/pages/search/sections/playlists.dart +++ b/lib/pages/search/sections/playlists.dart @@ -1,6 +1,6 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/components/horizontal_playbutton_card_view/horizontal_playbutton_card_view.dart'; import 'package:spotube/extensions/context.dart'; import 'package:spotube/provider/spotify/spotify.dart'; diff --git a/lib/pages/search/sections/tracks.dart b/lib/pages/search/sections/tracks.dart index bacbbb57..c483a969 100644 --- a/lib/pages/search/sections/tracks.dart +++ b/lib/pages/search/sections/tracks.dart @@ -2,7 +2,7 @@ import 'package:collection/collection.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/components/dialogs/prompt_dialog.dart'; import 'package:spotube/components/dialogs/select_device_dialog.dart'; import 'package:spotube/components/track_tile/track_tile.dart'; diff --git a/lib/pages/settings/sections/language_region.dart b/lib/pages/settings/sections/language_region.dart index 44b364af..16936027 100644 --- a/lib/pages/settings/sections/language_region.dart +++ b/lib/pages/settings/sections/language_region.dart @@ -1,7 +1,7 @@ import 'package:collection/collection.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/language_codes.dart'; import 'package:spotube/collections/spotify_markets.dart'; import 'package:spotube/collections/spotube_icons.dart'; diff --git a/lib/platform/discord/discord.dart b/lib/platform/discord/discord.dart new file mode 100644 index 00000000..944f4107 --- /dev/null +++ b/lib/platform/discord/discord.dart @@ -0,0 +1 @@ +export 'discord_native.dart' if (dart.library.html) 'discord_web.dart'; \ No newline at end of file diff --git a/lib/platform/discord/discord_web.dart b/lib/platform/discord/discord_web.dart new file mode 100644 index 00000000..63115e45 --- /dev/null +++ b/lib/platform/discord/discord_web.dart @@ -0,0 +1,5 @@ +class DiscordRPC { + Future<void> connect() async {} + Future<void> close() async {} + Future<void> setActivity(dynamic activity) async {} +} \ No newline at end of file diff --git a/lib/platform/media_controls/media_controls.dart b/lib/platform/media_controls/media_controls.dart new file mode 100644 index 00000000..96e6b491 --- /dev/null +++ b/lib/platform/media_controls/media_controls.dart @@ -0,0 +1,3 @@ +// Conditional exports for media controls functionality +export 'media_controls_native.dart' + if (dart.library.html) 'media_controls_web.dart'; \ No newline at end of file diff --git a/lib/platform/media_controls/media_controls_native.dart b/lib/platform/media_controls/media_controls_native.dart new file mode 100644 index 00000000..b9a7540b --- /dev/null +++ b/lib/platform/media_controls/media_controls_native.dart @@ -0,0 +1,2 @@ +// Native media controls implementation +export 'package:smtc_windows/smtc_windows.dart'; \ No newline at end of file diff --git a/lib/platform/media_controls/media_controls_web.dart b/lib/platform/media_controls/media_controls_web.dart new file mode 100644 index 00000000..55d9f496 --- /dev/null +++ b/lib/platform/media_controls/media_controls_web.dart @@ -0,0 +1 @@ +class SystemMediaTransportControls { Future<void> init() async {} void dispose() {} } \ No newline at end of file diff --git a/lib/platform/metadata/metadata.dart b/lib/platform/metadata/metadata.dart new file mode 100644 index 00000000..21b7cf1f --- /dev/null +++ b/lib/platform/metadata/metadata.dart @@ -0,0 +1 @@ +export 'metadata_native.dart' if (dart.library.html) 'metadata_web.dart'; diff --git a/lib/platform/metadata/metadata_native.dart b/lib/platform/metadata/metadata_native.dart new file mode 100644 index 00000000..f185f30a --- /dev/null +++ b/lib/platform/metadata/metadata_native.dart @@ -0,0 +1 @@ +export 'package:metadata_god/metadata_god.dart'; diff --git a/lib/platform/metadata/metadata_web.dart b/lib/platform/metadata/metadata_web.dart new file mode 100644 index 00000000..94473739 --- /dev/null +++ b/lib/platform/metadata/metadata_web.dart @@ -0,0 +1,5 @@ +class MetadataGod { + static Future<void> initialize() async {} + static Future<Map<String, dynamic>> readMetadata({required String file}) async => {}; + static Future<void> writeMetadata({required String file, Map<String, dynamic>? tags}) async {} +} diff --git a/lib/platform/spotify/spotify.dart b/lib/platform/spotify/spotify.dart new file mode 100644 index 00000000..884c21ee --- /dev/null +++ b/lib/platform/spotify/spotify.dart @@ -0,0 +1 @@ +export 'spotify_native.dart' if (dart.library.html) 'spotify_web.dart'; diff --git a/lib/platform/spotify/spotify_native.dart b/lib/platform/spotify/spotify_native.dart new file mode 100644 index 00000000..dc516ea7 --- /dev/null +++ b/lib/platform/spotify/spotify_native.dart @@ -0,0 +1 @@ +export 'package:spotify/spotify.dart'; diff --git a/lib/platform/spotify/spotify_web.dart b/lib/platform/spotify/spotify_web.dart new file mode 100644 index 00000000..6cafd87c --- /dev/null +++ b/lib/platform/spotify/spotify_web.dart @@ -0,0 +1,145 @@ +/// Web stubs mínimos para compilar. NO hacen llamadas reales. +/// Añade campos a medida que el código los requiera. + +class ExternalUrls { final Map<String, String>? data; ExternalUrls({this.data}); } +class Followers { final int? total; Followers({this.total}); } + +class User { + final String? id; + final String? displayName; + final List<SImage>? images; + User({this.id, this.displayName, this.images}); +} + +class ArtistSimple { final String? name; ArtistSimple({this.name}); } + +class Artist extends ArtistSimple { + final String? id; + final List<SImage>? images; + final int? popularity; + final Followers? followers; + Artist({this.id, super.name, this.images, this.popularity, this.followers}); +} + +class SImage { + String? url; + int? height; + int? width; + SImage({this.url, this.height, this.width}); +} +typedef Image = SImage; + +enum AlbumType { album, single, compilation, unknown } +enum Market { us, gb, ca, de, fr, it, es, au, jp, br, mx, ar, co, pe, cl, ve, ec, uy, py, bo, gf, sr, gy, fk, gt, bz, sv, hn, ni, cr, pa, cu, jm, ht, do_, pr, vi, ai, gp, mq, bl, mf, ag, dm, ms, kn, lc, vc, gd, tt, bb, tc, ky, bm, bs } + +class TrackLink { final String? href; final String? id; TrackLink({this.href, this.id}); } + +class TracksLink { final String? href; final int? total; TracksLink({this.href, this.total}); } + +class Paging<T> { + final List<T>? items; + final String? href; + final int? limit; + final String? next; + final int? offset; + final String? previous; + final int? total; + Paging({this.items, this.href, this.limit, this.next, this.offset, this.previous, this.total}); +} + +class TrackSimple { + final String? id; + final String? name; + final List<ArtistSimple>? artists; + final int? durationMs; + final bool? explicit_; + final ExternalUrls? externalUrls; + final int? popularity; + final Duration? duration; + TrackSimple({this.id, this.name, this.artists, this.durationMs, this.explicit_, this.externalUrls, this.popularity, this.duration}); +} + +class AlbumSimple { + final String? id; + final String? name; + final AlbumType? albumType; + final List<Image>? images; + final List<ArtistSimple>? artists; + final String? releaseDate; + AlbumSimple({this.id, this.name, this.albumType, this.images, this.artists, this.releaseDate}); +} + +class Album extends AlbumSimple { + Album({super.id, super.name, super.albumType, super.images, super.artists, super.releaseDate}); +} + +class PlaylistSimple { + final String? id; + final String? name; + final List<Image>? images; + final User? owner; + final String? description; + PlaylistSimple({this.id, this.name, this.images, this.owner, this.description}); +} + +class Playlist extends PlaylistSimple { + final Followers? followers; + Playlist({super.id, super.name, super.images, super.owner, super.description, this.followers}); +} + +class Track extends TrackSimple { + final AlbumSimple? album; + Track({super.id, super.name, super.artists, super.durationMs, super.explicit_, super.externalUrls, super.popularity, super.duration, this.album}); +} + +class Category { + final String? id; + final String? name; + final List<Image>? icons; + Category({this.id, this.name, this.icons}); +} + +class SpotifyApi { + SpotifyApi(dynamic credentials); + SpotifyApi.withAccessToken(String token); + dynamic get albums => _AlbumsApi(); +} + +class SpotifyApiCredentials { + final String? clientId; + final String? clientSecret; + final String? accessToken; + final String? refreshToken; + final String? redirectUri; + final List<String>? scopes; + + SpotifyApiCredentials({ + this.clientId, + this.clientSecret, + this.accessToken, + this.refreshToken, + this.redirectUri, + this.scopes, + }); +} + +class _AlbumsApi { + Future<Album> get(String? id) async => Album(); +} + +enum SearchType { track, album, artist, playlist } + +class SMTCWindows { + static SMTCWindows get instance => SMTCWindows._(); + SMTCWindows._(); + Future<void> enableSmtc() async {} + Future<void> disableSmtc() async {} +} + +/// Utiles que aparecen en extensiones: +class Metadata { + final List<Picture>? pictures; + final Map<String, dynamic>? picture; + Metadata({this.pictures, this.picture}); +} +class Picture { final String? mimeType; final List<int>? bytes; Picture({this.mimeType, this.bytes}); } diff --git a/lib/platform/tray_manager/tray_manager.dart b/lib/platform/tray_manager/tray_manager.dart new file mode 100644 index 00000000..5c4dcbdc --- /dev/null +++ b/lib/platform/tray_manager/tray_manager.dart @@ -0,0 +1,3 @@ +// Conditional exports for tray manager functionality +export 'tray_manager_native.dart' + if (dart.library.html) 'tray_manager_web.dart'; \ No newline at end of file diff --git a/lib/platform/tray_manager/tray_manager_native.dart b/lib/platform/tray_manager/tray_manager_native.dart new file mode 100644 index 00000000..69b2cc65 --- /dev/null +++ b/lib/platform/tray_manager/tray_manager_native.dart @@ -0,0 +1,2 @@ +// Native tray manager implementation +export 'package:tray_manager/tray_manager.dart'; \ No newline at end of file diff --git a/lib/platform/tray_manager/tray_manager_web.dart b/lib/platform/tray_manager/tray_manager_web.dart new file mode 100644 index 00000000..4736c325 --- /dev/null +++ b/lib/platform/tray_manager/tray_manager_web.dart @@ -0,0 +1,47 @@ +// Web stub implementation - tray manager not available on web + +class TrayManager { + static TrayManager get instance => TrayManager._(); + TrayManager._(); + + Future<void> setIcon(String path, {bool isTemplate = false}) async {} + Future<void> setToolTip(String toolTip) async {} + Future<void> setContextMenu(dynamic menu) async {} + Future<void> destroy() async {} +} + +TrayManager get trayManager => TrayManager.instance; + +mixin class TrayListener {} + +class Menu { + List<MenuItem> items; + Menu({required this.items}); +} + +class MenuItem { + String? label; + String? key; + bool? disabled; + bool? checked; + dynamic onClick; + dynamic click; + List<MenuItem>? submenu; + + MenuItem({ + this.label, + this.key, + this.disabled, + this.checked, + this.onClick, + this.click, + }); + + MenuItem.separator() : label = null, key = null, disabled = null, checked = null, onClick = null, click = null; + + MenuItem.submenu({ + this.label, + this.key, + required this.submenu, + }) : disabled = null, checked = null, onClick = null, click = null; +} \ No newline at end of file diff --git a/lib/platform/window_manager/window_manager.dart b/lib/platform/window_manager/window_manager.dart new file mode 100644 index 00000000..3e1ca0db --- /dev/null +++ b/lib/platform/window_manager/window_manager.dart @@ -0,0 +1,3 @@ +// Conditional exports for window manager functionality +export 'window_manager_native.dart' + if (dart.library.html) 'window_manager_web.dart'; \ No newline at end of file diff --git a/lib/platform/window_manager/window_manager_native.dart b/lib/platform/window_manager/window_manager_native.dart new file mode 100644 index 00000000..f1ca43f8 --- /dev/null +++ b/lib/platform/window_manager/window_manager_native.dart @@ -0,0 +1,2 @@ +// Native window manager implementation +export 'package:window_manager/window_manager.dart'; \ No newline at end of file diff --git a/lib/platform/window_manager/window_manager_web.dart b/lib/platform/window_manager/window_manager_web.dart new file mode 100644 index 00000000..83d6184f --- /dev/null +++ b/lib/platform/window_manager/window_manager_web.dart @@ -0,0 +1,49 @@ +// Web stub implementation - window manager not available on web + +class WindowManager { + static WindowManager get instance => WindowManager._(); + WindowManager._(); + + Future<void> ensureInitialized() async {} + Future<void> waitUntilReadyToShow() async {} + Future<void> setTitle(String title) async {} + Future<void> setTitleBarStyle(dynamic style, {dynamic windowButtonVisibility}) async {} + Future<void> setSkipTaskbar(bool skip) async {} + Future<void> setMinimumSize(dynamic size) async {} + Future<void> center() async {} + Future<void> show() async {} + Future<void> hide() async {} + Future<void> close() async {} + Future<bool> isFocused() async => false; + Future<bool> isVisible() async => false; + Future<bool> isMinimized() async => false; + Future<bool> isMaximized() async => false; + Future<void> minimize() async {} + Future<void> maximize() async {} + Future<void> unmaximize() async {} + Future<void> focus() async {} + Future<void> blur() async {} + Future<void> setAlwaysOnTop(bool flag) async {} + Future<void> setSize(dynamic size) async {} + Future<void> setPosition(dynamic position) async {} + Future<dynamic> getSize() async => null; + Future<dynamic> getPosition() async => null; +} + +WindowManager get windowManager => WindowManager.instance; + +class WindowListener {} + +enum TitleBarStyle { normal, hidden } + +class Size { + final double width; + final double height; + const Size(this.width, this.height); +} + +class Offset { + final double dx; + final double dy; + const Offset(this.dx, this.dy); +} \ No newline at end of file diff --git a/lib/provider/audio_player/audio_player.dart b/lib/provider/audio_player/audio_player.dart index aa93bd4f..2a3b67c4 100644 --- a/lib/provider/audio_player/audio_player.dart +++ b/lib/provider/audio_player/audio_player.dart @@ -3,7 +3,7 @@ import 'dart:math'; import 'package:drift/drift.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:media_kit/media_kit.dart' hide Track; -import 'package:spotify/spotify.dart' hide Playlist; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/extensions/list.dart'; import 'package:spotube/extensions/track.dart'; import 'package:spotube/models/database/database.dart'; diff --git a/lib/provider/audio_player/audio_player_streams.dart b/lib/provider/audio_player/audio_player_streams.dart index c221a2b0..cf6cda56 100644 --- a/lib/provider/audio_player/audio_player_streams.dart +++ b/lib/provider/audio_player/audio_player_streams.dart @@ -2,7 +2,7 @@ import 'dart:async'; import 'dart:math'; import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/models/local_track.dart'; import 'package:spotube/provider/audio_player/audio_player.dart'; import 'package:spotube/provider/audio_player/state.dart'; diff --git a/lib/provider/audio_player/state.dart b/lib/provider/audio_player/state.dart index 0e3004f5..78b5154e 100644 --- a/lib/provider/audio_player/state.dart +++ b/lib/provider/audio_player/state.dart @@ -1,5 +1,5 @@ import 'package:media_kit/media_kit.dart' hide Track; -import 'package:spotify/spotify.dart' hide Playlist; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/services/audio_player/audio_player.dart'; class AudioPlayerState { diff --git a/lib/provider/blacklist_provider.dart b/lib/provider/blacklist_provider.dart index a51d399f..b5915b9e 100644 --- a/lib/provider/blacklist_provider.dart +++ b/lib/provider/blacklist_provider.dart @@ -1,6 +1,6 @@ import 'package:collection/collection.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/models/current_playlist.dart'; import 'package:spotube/models/database/database.dart'; import 'package:spotube/provider/database/database.dart'; diff --git a/lib/provider/connect/connect.dart b/lib/provider/connect/connect.dart index 93d2fb88..aad7b8b2 100644 --- a/lib/provider/connect/connect.dart +++ b/lib/provider/connect/connect.dart @@ -9,7 +9,7 @@ import 'package:spotube/provider/audio_player/state.dart'; import 'package:spotube/services/audio_player/audio_player.dart'; import 'package:spotube/services/logger/logger.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'package:spotify/spotify.dart' hide Playlist; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/models/connect/connect.dart'; import 'package:spotube/provider/connect/clients.dart'; diff --git a/lib/provider/discord_provider.dart b/lib/provider/discord_provider.dart index 8f81fc51..fe542ab9 100644 --- a/lib/provider/discord_provider.dart +++ b/lib/provider/discord_provider.dart @@ -1,8 +1,7 @@ import 'dart:async'; -import 'package:flutter_discord_rpc/flutter_discord_rpc.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/extensions/artist_simple.dart'; import 'package:spotube/provider/audio_player/audio_player.dart'; import 'package:spotube/provider/user_preferences/user_preferences_provider.dart'; diff --git a/lib/provider/download_manager_provider.dart b/lib/provider/download_manager_provider.dart index 1b588399..82208335 100644 --- a/lib/provider/download_manager_provider.dart +++ b/lib/provider/download_manager_provider.dart @@ -6,9 +6,9 @@ import 'package:spotube/services/logger/logger.dart'; import 'package:collection/collection.dart'; import 'package:flutter/foundation.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'package:metadata_god/metadata_god.dart'; +import 'package:spotube/platform/metadata/metadata.dart'; import 'package:path/path.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/extensions/artist_simple.dart'; import 'package:spotube/extensions/image.dart'; import 'package:spotube/provider/user_preferences/user_preferences_provider.dart'; diff --git a/lib/provider/glance/glance.dart b/lib/provider/glance/glance.dart index 22faa13f..c9be9080 100644 --- a/lib/provider/glance/glance.dart +++ b/lib/provider/glance/glance.dart @@ -5,7 +5,7 @@ import 'package:home_widget/home_widget.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:http/http.dart'; import 'package:logger/logger.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/provider/audio_player/audio_player.dart'; import 'package:spotube/provider/server/server.dart'; import 'package:spotube/services/audio_player/audio_player.dart'; diff --git a/lib/provider/history/history.dart b/lib/provider/history/history.dart index 25b722ff..e5dfc46f 100644 --- a/lib/provider/history/history.dart +++ b/lib/provider/history/history.dart @@ -1,5 +1,5 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/models/database/database.dart'; import 'package:spotube/provider/database/database.dart'; diff --git a/lib/provider/history/top/albums.dart b/lib/provider/history/top/albums.dart index b11e62d2..5540fc34 100644 --- a/lib/provider/history/top/albums.dart +++ b/lib/provider/history/top/albums.dart @@ -3,7 +3,7 @@ import 'dart:convert'; import 'package:collection/collection.dart'; import 'package:drift/drift.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/provider/database/database.dart'; import 'package:spotube/provider/history/top.dart'; import 'package:spotube/provider/spotify/spotify.dart'; diff --git a/lib/provider/history/top/playlists.dart b/lib/provider/history/top/playlists.dart index 19eb3622..75817b44 100644 --- a/lib/provider/history/top/playlists.dart +++ b/lib/provider/history/top/playlists.dart @@ -1,7 +1,7 @@ import 'package:collection/collection.dart'; import 'package:drift/drift.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/models/database/database.dart'; import 'package:spotube/provider/database/database.dart'; import 'package:spotube/provider/history/top.dart'; diff --git a/lib/provider/history/top/tracks.dart b/lib/provider/history/top/tracks.dart index 3c057e56..1825dbd3 100644 --- a/lib/provider/history/top/tracks.dart +++ b/lib/provider/history/top/tracks.dart @@ -1,7 +1,7 @@ import 'package:collection/collection.dart'; import 'package:drift/drift.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/models/database/database.dart'; import 'package:spotube/provider/database/database.dart'; import 'package:spotube/provider/history/top.dart'; diff --git a/lib/provider/local_tracks/local_tracks_provider.dart b/lib/provider/local_tracks/local_tracks_provider.dart index c69d3169..ff706b84 100644 --- a/lib/provider/local_tracks/local_tracks_provider.dart +++ b/lib/provider/local_tracks/local_tracks_provider.dart @@ -4,12 +4,12 @@ import 'dart:io'; import 'package:spotube/services/logger/logger.dart'; import 'package:flutter/foundation.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'package:metadata_god/metadata_god.dart'; +import 'package:spotube/platform/metadata/metadata.dart'; import 'package:mime/mime.dart'; import 'package:path/path.dart'; import 'package:path_provider/path_provider.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/extensions/track.dart'; import 'package:spotube/models/local_track.dart'; import 'package:spotube/provider/user_preferences/user_preferences_provider.dart'; diff --git a/lib/provider/scrobbler/scrobbler.dart b/lib/provider/scrobbler/scrobbler.dart index 8aff0438..cbee849e 100644 --- a/lib/provider/scrobbler/scrobbler.dart +++ b/lib/provider/scrobbler/scrobbler.dart @@ -3,7 +3,7 @@ import 'dart:async'; import 'package:drift/drift.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:scrobblenaut/scrobblenaut.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/env.dart'; import 'package:spotube/extensions/artist_simple.dart'; import 'package:spotube/models/database/database.dart'; diff --git a/lib/provider/server/routes/connect.dart b/lib/provider/server/routes/connect.dart index 6c4d8ce0..b96c92a8 100644 --- a/lib/provider/server/routes/connect.dart +++ b/lib/provider/server/routes/connect.dart @@ -6,7 +6,7 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; import 'package:shelf/shelf.dart'; import 'package:shelf_web_socket/shelf_web_socket.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/routes.dart'; import 'package:spotube/extensions/context.dart'; import 'package:spotube/models/connect/connect.dart'; diff --git a/lib/provider/server/routes/playback.dart b/lib/provider/server/routes/playback.dart index ccbeb7ab..b4d58ef1 100644 --- a/lib/provider/server/routes/playback.dart +++ b/lib/provider/server/routes/playback.dart @@ -5,7 +5,7 @@ import 'package:dio/dio.dart' hide Response; import 'package:dio/dio.dart' as dio_lib; import 'package:flutter/foundation.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'package:metadata_god/metadata_god.dart'; +import 'package:spotube/platform/metadata/metadata.dart'; import 'package:path/path.dart'; import 'package:shelf/shelf.dart'; import 'package:spotube/extensions/artist_simple.dart'; diff --git a/lib/provider/spotify/spotify.dart b/lib/provider/spotify/spotify.dart index a0753fcb..50352d21 100644 --- a/lib/provider/spotify/spotify.dart +++ b/lib/provider/spotify/spotify.dart @@ -16,7 +16,7 @@ import 'package:shadcn_flutter/shadcn_flutter.dart'; import 'package:intl/intl.dart'; import 'package:lrc/lrc.dart'; import 'package:package_info_plus/package_info_plus.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:hooks_riverpod/hooks_riverpod.dart'; // ignore: depend_on_referenced_packages, implementation_imports import 'package:riverpod/src/async_notifier.dart'; diff --git a/lib/provider/tray_manager/tray_manager.dart b/lib/provider/tray_manager/tray_manager.dart index 9cc4becc..3897410c 100644 --- a/lib/provider/tray_manager/tray_manager.dart +++ b/lib/provider/tray_manager/tray_manager.dart @@ -2,8 +2,8 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:spotube/provider/tray_manager/tray_menu.dart'; import 'package:spotube/provider/user_preferences/user_preferences_provider.dart'; import 'package:spotube/utils/platform.dart'; -import 'package:tray_manager/tray_manager.dart'; -import 'package:window_manager/window_manager.dart'; +import 'package:spotube/platform/tray_manager/tray_manager.dart'; +import 'package:spotube/platform/window_manager/window_manager.dart'; class SystemTrayManager with TrayListener { final Ref ref; diff --git a/lib/provider/tray_manager/tray_menu.dart b/lib/provider/tray_manager/tray_menu.dart index 42a3f948..214f6dde 100644 --- a/lib/provider/tray_manager/tray_menu.dart +++ b/lib/provider/tray_manager/tray_menu.dart @@ -4,8 +4,8 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:spotube/provider/audio_player/audio_player.dart'; import 'package:spotube/services/audio_player/audio_player.dart'; import 'package:media_kit/media_kit.dart' hide Track; -import 'package:tray_manager/tray_manager.dart'; -import 'package:window_manager/window_manager.dart'; +import 'package:spotube/platform/tray_manager/tray_manager.dart'; +import 'package:spotube/platform/window_manager/window_manager.dart'; final audioPlayerLoopMode = StreamProvider<PlaylistMode>((ref) { return audioPlayer.loopModeStream; diff --git a/lib/provider/user_preferences/user_preferences_provider.dart b/lib/provider/user_preferences/user_preferences_provider.dart index 30ee8b3f..45de0153 100644 --- a/lib/provider/user_preferences/user_preferences_provider.dart +++ b/lib/provider/user_preferences/user_preferences_provider.dart @@ -4,7 +4,7 @@ import 'package:hooks_riverpod/hooks_riverpod.dart'; import 'package:path/path.dart'; import 'package:path_provider/path_provider.dart' as paths; import 'package:shadcn_flutter/shadcn_flutter.dart' hide join; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/models/database/database.dart'; import 'package:spotube/modules/settings/color_scheme_picker_dialog.dart'; import 'package:spotube/provider/database/database.dart'; @@ -12,7 +12,7 @@ import 'package:spotube/services/audio_player/audio_player.dart'; import 'package:spotube/services/logger/logger.dart'; import 'package:spotube/services/sourced_track/enums.dart'; import 'package:spotube/utils/platform.dart'; -import 'package:window_manager/window_manager.dart'; +import 'package:spotube/platform/window_manager/window_manager.dart'; import 'package:open_file/open_file.dart'; typedef UserPreferences = PreferencesTableData; diff --git a/lib/services/audio_player/audio_player.dart b/lib/services/audio_player/audio_player.dart index 4febecdf..d175125d 100644 --- a/lib/services/audio_player/audio_player.dart +++ b/lib/services/audio_player/audio_player.dart @@ -3,7 +3,7 @@ import 'dart:io'; import 'package:media_kit/media_kit.dart' hide Track; import 'package:spotube/services/logger/logger.dart'; import 'package:flutter/foundation.dart'; -import 'package:spotify/spotify.dart' hide Playlist; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/models/local_track.dart'; import 'package:spotube/services/audio_player/custom_player.dart'; import 'dart:async'; diff --git a/lib/services/audio_player/custom_player.dart b/lib/services/audio_player/custom_player.dart index f0dc8f13..6b5bd3ce 100644 --- a/lib/services/audio_player/custom_player.dart +++ b/lib/services/audio_player/custom_player.dart @@ -1,3 +1,4 @@ +import "package:flutter/foundation.dart" show kIsWeb; import 'dart:async'; import 'package:spotube/services/logger/logger.dart'; import 'package:media_kit/media_kit.dart'; @@ -25,7 +26,7 @@ class CustomPlayer extends Player { : _playerStateStream = StreamController.broadcast(), _shuffleStream = StreamController.broadcast(), _shuffled = false { - nativePlayer.setProperty("network-timeout", "120"); + if (!kIsWeb) nativePlayer.setProperty("network-timeout", "120"); _subscriptions = [ stream.buffering.listen((event) { @@ -61,11 +62,11 @@ class CustomPlayer extends Player { await _androidAudioManager!.generateAudioSessionId(); notifyAudioSessionUpdate(true); - await nativePlayer.setProperty( + if (!kIsWeb) await nativePlayer.setProperty( "audiotrack-session-id", _androidAudioSessionId.toString(), ); - await nativePlayer.setProperty("ao", "audiotrack,opensles,"); + if (!kIsWeb) await nativePlayer.setProperty("ao", "audiotrack,opensles,"); }); } } @@ -139,9 +140,9 @@ class CustomPlayer extends Player { Future<void> setAudioNormalization(bool normalize) async { if (normalize) { - await nativePlayer.setProperty('af', 'dynaudnorm=g=5:f=250:r=0.9:p=0.5'); + if (!kIsWeb) await nativePlayer.setProperty('af', 'dynaudnorm=g=5:f=250:r=0.9:p=0.5'); } else { - await nativePlayer.setProperty('af', ''); + if (!kIsWeb) await nativePlayer.setProperty('af', ''); } } } diff --git a/lib/services/audio_services/audio_services.dart b/lib/services/audio_services/audio_services.dart index 060a7f41..a8375c73 100644 --- a/lib/services/audio_services/audio_services.dart +++ b/lib/services/audio_services/audio_services.dart @@ -1,7 +1,7 @@ import 'package:audio_service/audio_service.dart'; import 'package:shadcn_flutter/shadcn_flutter.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/collections/env.dart'; import 'package:spotube/extensions/artist_simple.dart'; import 'package:spotube/extensions/image.dart'; diff --git a/lib/services/audio_services/windows_audio_service.dart b/lib/services/audio_services/windows_audio_service.dart index 8edc5069..64f9a7c9 100644 --- a/lib/services/audio_services/windows_audio_service.dart +++ b/lib/services/audio_services/windows_audio_service.dart @@ -1,8 +1,8 @@ import 'dart:async'; import 'package:hooks_riverpod/hooks_riverpod.dart'; -import 'package:smtc_windows/smtc_windows.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/media_controls/media_controls.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/extensions/artist_simple.dart'; import 'package:spotube/extensions/image.dart'; import 'package:spotube/provider/audio_player/audio_player.dart'; diff --git a/lib/services/custom_spotify_endpoints/spotify_endpoints.dart b/lib/services/custom_spotify_endpoints/spotify_endpoints.dart index c05095b3..022aafe7 100644 --- a/lib/services/custom_spotify_endpoints/spotify_endpoints.dart +++ b/lib/services/custom_spotify_endpoints/spotify_endpoints.dart @@ -1,7 +1,7 @@ import 'dart:convert'; import 'package:dio/dio.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/models/spotify/home_feed.dart'; import 'package:spotube/models/spotify_friends.dart'; import 'package:timezone/timezone.dart' as tz; diff --git a/lib/services/sourced_track/exceptions.dart b/lib/services/sourced_track/exceptions.dart index 85bc5b27..533f4f4b 100644 --- a/lib/services/sourced_track/exceptions.dart +++ b/lib/services/sourced_track/exceptions.dart @@ -1,4 +1,4 @@ -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; class TrackNotFoundError extends Error { final Track track; diff --git a/lib/services/sourced_track/sourced_track.dart b/lib/services/sourced_track/sourced_track.dart index bf0b22e6..871c06b2 100644 --- a/lib/services/sourced_track/sourced_track.dart +++ b/lib/services/sourced_track/sourced_track.dart @@ -1,5 +1,5 @@ import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/models/database/database.dart'; import 'package:spotube/provider/user_preferences/user_preferences_provider.dart'; diff --git a/lib/services/sourced_track/sources/invidious.dart b/lib/services/sourced_track/sources/invidious.dart index 4a32ad41..7adaead6 100644 --- a/lib/services/sourced_track/sources/invidious.dart +++ b/lib/services/sourced_track/sources/invidious.dart @@ -1,7 +1,7 @@ import 'package:collection/collection.dart'; import 'package:drift/drift.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/models/database/database.dart'; import 'package:spotube/provider/database/database.dart'; import 'package:spotube/provider/user_preferences/user_preferences_provider.dart'; diff --git a/lib/services/sourced_track/sources/jiosaavn.dart b/lib/services/sourced_track/sources/jiosaavn.dart index 1434e4f7..f3497bb3 100644 --- a/lib/services/sourced_track/sources/jiosaavn.dart +++ b/lib/services/sourced_track/sources/jiosaavn.dart @@ -1,7 +1,7 @@ import 'package:collection/collection.dart'; import 'package:drift/drift.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/models/database/database.dart'; import 'package:spotube/provider/database/database.dart'; import 'package:spotube/services/sourced_track/enums.dart'; diff --git a/lib/services/sourced_track/sources/piped.dart b/lib/services/sourced_track/sources/piped.dart index 7ab9df44..3736f753 100644 --- a/lib/services/sourced_track/sources/piped.dart +++ b/lib/services/sourced_track/sources/piped.dart @@ -2,7 +2,7 @@ import 'package:collection/collection.dart'; import 'package:drift/drift.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; import 'package:piped_client/piped_client.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/models/database/database.dart'; import 'package:spotube/provider/database/database.dart'; import 'package:spotube/provider/user_preferences/user_preferences_provider.dart'; diff --git a/lib/services/sourced_track/sources/youtube.dart b/lib/services/sourced_track/sources/youtube.dart index 193bdc0d..07dd82ea 100644 --- a/lib/services/sourced_track/sources/youtube.dart +++ b/lib/services/sourced_track/sources/youtube.dart @@ -1,7 +1,7 @@ import 'package:collection/collection.dart'; import 'package:drift/drift.dart'; import 'package:flutter_riverpod/flutter_riverpod.dart'; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/models/database/database.dart'; import 'package:spotube/provider/database/database.dart'; import 'package:spotube/provider/youtube_engine/youtube_engine.dart'; diff --git a/lib/utils/service_utils.dart b/lib/utils/service_utils.dart index 72a98a0b..4ee0a194 100644 --- a/lib/utils/service_utils.dart +++ b/lib/utils/service_utils.dart @@ -6,7 +6,7 @@ import 'package:flutter_cache_manager/flutter_cache_manager.dart'; import 'package:html/dom.dart' hide Text; import 'package:shadcn_flutter/shadcn_flutter.dart' hide Element; -import 'package:spotify/spotify.dart'; +import 'package:spotube/platform/spotify/spotify.dart'; import 'package:spotube/pages/library/user_local_tracks/user_local_tracks.dart'; import 'package:spotube/modules/root/update_dialog.dart';