mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-06 01:50:30 +00:00
feat: generate the gt command reference from gitea/cli
update_cli_docs.sh runs gt's own generator and lays the pages out for the site: one directory per command group, front matter, titles, sidebar order, fenced help text and rewritten links. --released succeeds while no series is documented. A weekly workflow proposes updates like the runner's. Signed-off-by: bircni <[email protected]>
This commit is contained in:
261 files changed
+15116
-2
No files matched your search
@@ -0,0 +1,47 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: "Delete an attachment"
|
||||
---
|
||||
|
||||
# gt pr attachment delete
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Delete an attachment
|
||||
|
||||
```
|
||||
gt pr attachment delete {<number> | <url>} <attachment-id> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr attachment delete 13 9 --yes
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for delete
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr attachment](../../pr/attachment/index.md): Manage the attachments of pull requests
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: "Download an attachment"
|
||||
---
|
||||
|
||||
# gt pr attachment download
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Download an attachment
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Download an attachment into the current directory under its own name, or where -O/--output
|
||||
or -D/--dir say. An existing file is kept unless --clobber replaces it or --skip-existing
|
||||
skips the download.
|
||||
```
|
||||
|
||||
```
|
||||
gt pr attachment download {<number> | <url>} <attachment-id> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr attachment download 13 9
|
||||
$ gt pr attachment download 13 9 --output crash.log --clobber
|
||||
# Write the file to standard output
|
||||
$ gt pr attachment download 13 9 -O - | less
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--clobber Replace an existing file
|
||||
-D, --dir string Directory to download into
|
||||
-h, --help help for download
|
||||
-O, --output string File or directory to write to, or - for standard output (default: the download's name)
|
||||
--skip-existing Keep an existing file and skip the download
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr attachment](../../pr/attachment/index.md): Manage the attachments of pull requests
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: "Rename an attachment"
|
||||
---
|
||||
|
||||
# gt pr attachment edit
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Rename an attachment
|
||||
|
||||
```
|
||||
gt pr attachment edit {<number> | <url>} <attachment-id> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr attachment edit 13 9 --name crash-2026-10-11.log
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for edit
|
||||
--name name New file name
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr attachment](../../pr/attachment/index.md): Manage the attachments of pull requests
|
||||
@@ -0,0 +1,54 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: "Manage the attachments of pull requests"
|
||||
---
|
||||
|
||||
# gt pr attachment
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Manage the attachments of pull requests
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
List, view, upload, download, rename and delete the files attached to a pull request. Attachments
|
||||
are addressed by the pull request number and the attachment ID that attachment list shows.
|
||||
```
|
||||
|
||||
```
|
||||
gt pr attachment [flags]
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for attachment
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr](../../pr/index.md): Manage pull requests
|
||||
* [gt pr attachment delete](../../pr/attachment/delete.md): Delete an attachment
|
||||
* [gt pr attachment download](../../pr/attachment/download.md): Download an attachment
|
||||
* [gt pr attachment edit](../../pr/attachment/edit.md): Rename an attachment
|
||||
* [gt pr attachment list](../../pr/attachment/list.md): List attachments
|
||||
* [gt pr attachment upload](../../pr/attachment/upload.md): Attach a file
|
||||
* [gt pr attachment view](../../pr/attachment/view.md): View an attachment
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
description: "List attachments"
|
||||
---
|
||||
|
||||
# gt pr attachment list
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
List attachments
|
||||
|
||||
```
|
||||
gt pr attachment list {<number> | <url>} [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr attachment list 13
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for list
|
||||
-L, --limit int Maximum number of results (1..1000) (default 30)
|
||||
--page int Result page (default 1)
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr attachment](../../pr/attachment/index.md): Manage the attachments of pull requests
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
description: "Attach a file"
|
||||
---
|
||||
|
||||
# gt pr attachment upload
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Attach a file
|
||||
|
||||
```
|
||||
gt pr attachment upload {<number> | <url>} <file> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr attachment upload 13 crash.log
|
||||
$ gt pr attachment upload 13 screenshot.png --name before.png
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for upload
|
||||
--name name File name of the attachment (default: the local file name)
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr attachment](../../pr/attachment/index.md): Manage the attachments of pull requests
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
description: "View an attachment"
|
||||
---
|
||||
|
||||
# gt pr attachment view
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
View an attachment
|
||||
|
||||
```
|
||||
gt pr attachment view {<number> | <url>} <attachment-id> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr attachment view 13 9
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for view
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr attachment](../../pr/attachment/index.md): Manage the attachments of pull requests
|
||||
@@ -0,0 +1,59 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: "Check out a pull request"
|
||||
---
|
||||
|
||||
# gt pr checkout
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Check out a pull request
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Check out the head of a pull request in a local branch that tracks the head branch, so
|
||||
that git push updates it and pr commands without an argument select the pull request.
|
||||
```
|
||||
|
||||
```
|
||||
gt pr checkout {<number> | <url> | <branch>} [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr checkout 13
|
||||
$ gt pr co feature/login
|
||||
$ gt pr checkout 13 --update
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-b, --branch string Local branch name (default: the head branch name when free, else OWNER/BRANCH or pr/NUMBER)
|
||||
--detach Check out the PR commit without creating or changing a branch
|
||||
-h, --help help for checkout
|
||||
--update Fast-forward an existing branch to the PR head; reject divergence
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr](../pr/index.md): Manage pull requests
|
||||
@@ -0,0 +1,65 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: "Show the status checks of a pull request"
|
||||
---
|
||||
|
||||
# gt pr checks
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Show the status checks of a pull request
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Show the latest status of each check of a pull request's head commit.
|
||||
|
||||
gt exits with 8 while checks are pending and with 1 when a check failed, like gh. With
|
||||
--watch, it waits until every check finished, or one failed, and polls on through an outage of
|
||||
the instance of up to 5 minutes.
|
||||
```
|
||||
|
||||
```
|
||||
gt pr checks [<number> | <url> | <branch>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# Show the checks of the current branch's pull request
|
||||
$ gt pr checks
|
||||
|
||||
# Wait until the checks of #13 finish, then merge it
|
||||
$ gt pr checks 13 --watch && gt pr merge 13
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for checks
|
||||
--interval duration Time between refreshes with --watch (default 5s)
|
||||
--timeout duration Longest time to wait with --watch (default 1h0m0s)
|
||||
--watch Wait for the checks to finish, stopping at the first failure
|
||||
-w, --web Open the pull request in the browser
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr](../pr/index.md): Manage pull requests
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
description: "Delete the branches of a merged or closed pull request"
|
||||
---
|
||||
|
||||
# gt pr clean
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Delete the branches of a merged or closed pull request
|
||||
|
||||
```
|
||||
gt pr clean [<number> | <url> | <branch>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# After #13 was merged, delete its branch locally and on Gitea
|
||||
$ gt pr clean 13
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for clean
|
||||
--ignore-sha Find the local branch by name instead of commit hash
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr](../pr/index.md): Manage pull requests
|
||||
@@ -0,0 +1,50 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
description: "Close a pull request"
|
||||
---
|
||||
|
||||
# gt pr close
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Close a pull request
|
||||
|
||||
```
|
||||
gt pr close [<number> | <url> | <branch>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr close 13
|
||||
$ gt pr close 13 -c "Superseded by #15" --delete-branch
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-c, --comment string Leave a comment before changing the state
|
||||
-d, --delete-branch Delete the head branch on Gitea, also in a fork you can push to, and locally when it is checked out
|
||||
-h, --help help for close
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr](../pr/index.md): Manage pull requests
|
||||
@@ -0,0 +1,52 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: "Add a comment to a pull request"
|
||||
---
|
||||
|
||||
# gt pr comment create
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Add a comment to a pull request
|
||||
|
||||
```
|
||||
gt pr comment create [<number> | <url> | <branch>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr comment create 13 --body "Looks good"
|
||||
$ gt pr comment add 13 --editor
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--attachment File File to attach to the comment (repeatable)
|
||||
-b, --body text Comment text
|
||||
-F, --body-file file Read the comment from file, or - for stdin
|
||||
-e, --editor Write the comment in the configured editor
|
||||
-h, --help help for create
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr comment](../../pr/comment/index.md): Add a comment to a pull request
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: "Delete a comment"
|
||||
---
|
||||
|
||||
# gt pr comment delete
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Delete a comment
|
||||
|
||||
```
|
||||
gt pr comment delete <comment-id> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr comment delete 81 --yes
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for delete
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr comment](../../pr/comment/index.md): Add a comment to a pull request
|
||||
@@ -0,0 +1,58 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: "Edit a comment"
|
||||
---
|
||||
|
||||
# gt pr comment edit
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Edit a comment
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Replace the text of a comment. Without --body or --body-file, the editor or the prompt starts
|
||||
from the current text.
|
||||
```
|
||||
|
||||
```
|
||||
gt pr comment edit <comment-id> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr comment edit 81 --body "Fixed in #15"
|
||||
$ gt pr comment edit 81
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-b, --body text Comment text
|
||||
-F, --body-file file Read the comment from file, or - for stdin
|
||||
-e, --editor Write the comment in the configured editor
|
||||
-h, --help help for edit
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr comment](../../pr/comment/index.md): Add a comment to a pull request
|
||||
@@ -0,0 +1,69 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
description: "Add a comment to a pull request"
|
||||
---
|
||||
|
||||
# gt pr comment
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Add a comment to a pull request
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Add a comment to a pull request, or edit or delete your last comment on it.
|
||||
|
||||
Without --body, --body-file or --editor, the configured editor opens, or a multi-line prompt
|
||||
asks for the comment. The subcommands list, view, edit and delete comments by their ID.
|
||||
```
|
||||
|
||||
```
|
||||
gt pr comment [<number> | <url> | <branch>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr comment 13 --body "Fixed in #14"
|
||||
$ gt pr comment 13 --edit-last --body "Fixed in #15"
|
||||
$ gt pr comment list 13
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--attachment File File to attach to the comment (repeatable)
|
||||
-b, --body text Comment text
|
||||
-F, --body-file file Read the comment from file, or - for stdin
|
||||
--delete-last Delete your last comment
|
||||
--edit-last Edit your last comment instead of adding one
|
||||
-e, --editor Write the comment in the configured editor
|
||||
-h, --help help for comment
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr](../../pr/index.md): Manage pull requests
|
||||
* [gt pr comment create](../../pr/comment/create.md): Add a comment to a pull request
|
||||
* [gt pr comment delete](../../pr/comment/delete.md): Delete a comment
|
||||
* [gt pr comment edit](../../pr/comment/edit.md): Edit a comment
|
||||
* [gt pr comment list](../../pr/comment/list.md): List the comments on a pull request
|
||||
* [gt pr comment view](../../pr/comment/view.md): View a comment
|
||||
@@ -0,0 +1,50 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
description: "List the comments on a pull request"
|
||||
---
|
||||
|
||||
# gt pr comment list
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
List the comments on a pull request
|
||||
|
||||
```
|
||||
gt pr comment list [<number> | <url> | <branch>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr comment list 13
|
||||
$ gt pr comment list 13 --json id,author,body
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for list
|
||||
-L, --limit int Maximum number of results (1..1000) (default 30)
|
||||
--page int Result page (default 1)
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr comment](../../pr/comment/index.md): Add a comment to a pull request
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
description: "View a comment"
|
||||
---
|
||||
|
||||
# gt pr comment view
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
View a comment
|
||||
|
||||
```
|
||||
gt pr comment view <comment-id> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr comment view 81
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for view
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr comment](../../pr/comment/index.md): Add a comment to a pull request
|
||||
@@ -0,0 +1,94 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
description: "Create a pull request"
|
||||
---
|
||||
|
||||
# gt pr create
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Create a pull request
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Create a pull request from the current branch, or from --head.
|
||||
|
||||
On a terminal without flags, gt asks for the title and body, then what to do next: submit,
|
||||
submit as a draft, add metadata or change the branches. Any flag of this command, such as
|
||||
--fill, --head or --base (but not global flags such as --repo), skips the questions: the
|
||||
title is then --title, else the commit message of a single-commit branch, else the branch
|
||||
name.
|
||||
|
||||
A branch that is not on the remote yet is pushed first, with its upstream set, after a
|
||||
confirmation; without a terminal, pass --yes to push it. A branch that
|
||||
does not track a branch of the same name yet goes to the fork when origin is a fork of the
|
||||
repository, or, when origin is not the repository itself, to the only remote of your own
|
||||
fork; otherwise it goes to the repository's remote.
|
||||
```
|
||||
|
||||
```
|
||||
gt pr create [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# Create a pull request for the current branch interactively
|
||||
$ gt pr create
|
||||
|
||||
# Take the title and body from the commits, without questions
|
||||
$ gt pr create --fill
|
||||
|
||||
# In a script, also push the branch without asking
|
||||
$ gt pr create --fill --yes
|
||||
|
||||
$ gt pr create -t "Add login" -b "Closes #1" -B develop -r carol -l enhancement
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--agit Create the pull request through AGit push (refs/for)
|
||||
--allow-maintainer-edits Allow maintainers to push to the head branch (default true)
|
||||
-a, --assignee strings Assign users by username; @me for yourself
|
||||
--attachment stringArray Attach a file to the pull request (repeatable)
|
||||
-B, --base string Base branch (default: the repository's default branch)
|
||||
-b, --body string Pull request body
|
||||
-F, --body-file file Read the body from file, or - for stdin
|
||||
--deadline date Due date: YYYY-MM-DD, RFC3339 or Unix timestamp; only the date counts, as the end of that day in UTC
|
||||
-d, --draft Create a draft pull request
|
||||
-e, --editor Write the body in your editor, starting from the repository's template
|
||||
-f, --fill Skip the questions and take the title and body from the commits
|
||||
-H, --head string Head branch, or OWNER:BRANCH for a fork (default: the current branch)
|
||||
-h, --help help for create
|
||||
-l, --label strings Apply labels by name; repo: or org: picks between same-named labels
|
||||
-m, --milestone string Milestone title or ID
|
||||
-p, --project title Add the pull request to the project with this title, the repository's or its organization's (repeatable)
|
||||
-r, --reviewer strings Request reviews from users; @me for yourself
|
||||
--reviewer-team strings Request reviews from teams within the repository's organization
|
||||
-t, --title string Pull request title (default: the commit message of a single-commit branch, or the branch name)
|
||||
--topic string AGit topic name (default: head branch); requires --agit
|
||||
-w, --web Open the comparison page in the browser to create the pull request there
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr](../pr/index.md): Manage pull requests
|
||||
@@ -0,0 +1,61 @@
|
||||
---
|
||||
sidebar_position: 8
|
||||
description: "Show the changes of a pull request"
|
||||
---
|
||||
|
||||
# gt pr diff
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Show the changes of a pull request
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Show the changes of a pull request as a unified diff.
|
||||
|
||||
On a terminal the diff is colored and paged. Piped, it is written unchanged, so that
|
||||
gt pr diff 13 | git apply works, and --name-only writes the exact file names.
|
||||
```
|
||||
|
||||
```
|
||||
gt pr diff [<number> | <url> | <branch>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr diff
|
||||
$ gt pr diff 13 --name-only
|
||||
$ gt pr diff 13 | git apply
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--color string Color the diff {auto|always|never} (default "auto")
|
||||
-h, --help help for diff
|
||||
--name-only List only the names of the changed files
|
||||
-w, --web Open the changed files in the browser
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr](../pr/index.md): Manage pull requests
|
||||
@@ -0,0 +1,84 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
description: "Edit a pull request"
|
||||
---
|
||||
|
||||
# gt pr edit
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Edit a pull request
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Edit the title, body, base branch, reviewers, labels, assignees, milestone or due date of a
|
||||
pull request, or mark it as a draft or ready for review.
|
||||
|
||||
Gitea changes the milestone, assignees and due date only for people who can write to the pull
|
||||
requests of the repository, and leaves them as they were for the author of a pull request who
|
||||
cannot: gt then names the flags it left out and fails. Gitea refuses their label changes
|
||||
outright, so gt sends the other changes first.
|
||||
```
|
||||
|
||||
```
|
||||
gt pr edit [<number> | <url> | <branch>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr edit 13 --title "Add login support" --add-reviewer carol
|
||||
$ gt pr edit --base develop
|
||||
$ gt pr edit 13 --editor
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--add-assignee login Add assignees by login; @me for yourself
|
||||
--add-label name Add labels by name; prefix repo: or org: to disambiguate
|
||||
--add-project title Add the pull request to the project with this title (repeatable)
|
||||
--add-reviewer strings Request reviews from users; @me for yourself
|
||||
--add-reviewer-team strings Request reviews from teams of the repository's organization
|
||||
--allow-maintainer-edit Allow maintainers to push to the head branch
|
||||
-B, --base string Base branch
|
||||
-b, --body string Pull request body (empty clears)
|
||||
-F, --body-file file Read the body from file, or - for stdin
|
||||
--deadline date Due date: YYYY-MM-DD, RFC3339 or Unix timestamp; only the date counts, as the end of that day in UTC; empty clears it
|
||||
--draft Mark the pull request as a draft (same as gt pr ready --undo)
|
||||
-e, --editor Edit the current body in your editor
|
||||
-h, --help help for edit
|
||||
-m, --milestone string Milestone title or ID; 0 removes it
|
||||
--ready Mark the pull request as ready for review (same as gt pr ready)
|
||||
--remove-assignee login Remove assignees by login; @me for yourself
|
||||
--remove-label name Remove labels by name
|
||||
--remove-milestone Remove the milestone
|
||||
--remove-project title Take the pull request off the project with this title (repeatable)
|
||||
--remove-reviewer strings Withdraw review requests from users
|
||||
--remove-reviewer-team strings Withdraw review requests from teams
|
||||
--set-assignees strings Replace all assignees; an empty value clears them
|
||||
--set-labels strings Replace all labels; an empty value clears them
|
||||
-t, --title string Pull request title
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr](../pr/index.md): Manage pull requests
|
||||
@@ -0,0 +1,75 @@
|
||||
---
|
||||
sidebar_position: 15
|
||||
description: "Manage pull requests"
|
||||
---
|
||||
|
||||
# gt pr
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Manage pull requests
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Work with Gitea pull requests: list, view, create, review, check out and merge them.
|
||||
|
||||
Commands that act on one pull request take a number, a URL or a branch name, and without
|
||||
one select the pull request of the current branch. pr attachment takes a number or a URL.
|
||||
```
|
||||
|
||||
```
|
||||
gt pr [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr list --author @me
|
||||
$ gt pr create --fill
|
||||
$ gt pr merge --squash --delete-branch
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for pr
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt](../index.md): Work with Gitea from your terminal
|
||||
* [gt pr attachment](../pr/attachment/index.md): Manage the attachments of pull requests
|
||||
* [gt pr checkout](../pr/checkout.md): Check out a pull request
|
||||
* [gt pr checks](../pr/checks.md): Show the status checks of a pull request
|
||||
* [gt pr clean](../pr/clean.md): Delete the branches of a merged or closed pull request
|
||||
* [gt pr close](../pr/close.md): Close a pull request
|
||||
* [gt pr comment](../pr/comment/index.md): Add a comment to a pull request
|
||||
* [gt pr create](../pr/create.md): Create a pull request
|
||||
* [gt pr diff](../pr/diff.md): Show the changes of a pull request
|
||||
* [gt pr edit](../pr/edit.md): Edit a pull request
|
||||
* [gt pr list](../pr/list.md): List pull requests
|
||||
* [gt pr merge](../pr/merge.md): Merge a pull request
|
||||
* [gt pr ready](../pr/ready.md): Mark a pull request as ready for review
|
||||
* [gt pr reopen](../pr/reopen.md): Reopen a pull request
|
||||
* [gt pr review](../pr/review/index.md): Review a pull request or manage its reviews
|
||||
* [gt pr status](../pr/status.md): Show the status of your pull requests
|
||||
* [gt pr timeline](../pr/timeline.md): Show the activity on a pull request
|
||||
* [gt pr view](../pr/view.md): View a pull request
|
||||
@@ -0,0 +1,74 @@
|
||||
---
|
||||
sidebar_position: 10
|
||||
description: "List pull requests"
|
||||
---
|
||||
|
||||
# gt pr list
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
List pull requests
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
List the pull requests of a repository, newest first.
|
||||
|
||||
The reviewers, reviewer_teams and review_decision JSON fields come from the reviews of each pull
|
||||
request, and merged_by from reading each pull request again. gt only makes these requests when --json
|
||||
names the fields, or selects every field and a --jq expression names them (see gt help formatting).
|
||||
--limit bounds how many requests it makes.
|
||||
```
|
||||
|
||||
```
|
||||
gt pr list [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr list
|
||||
$ gt pr list --author @me --state all
|
||||
$ gt pr list --json number,title,head --jq '.[] | select(.head == "feature/login")'
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-a, --assignee string Filter by assignee; @me for yourself
|
||||
-A, --author string Filter by author; @me for yourself
|
||||
-B, --base string Filter by base branch
|
||||
-d, --draft Show only drafts
|
||||
-H, --head string Filter by head branch, or OWNER:BRANCH for a fork
|
||||
-h, --help help for list
|
||||
-l, --label strings Filter by labels; repo: or org: picks between same-named labels
|
||||
-L, --limit int Maximum number of results (1..1000) (default 30)
|
||||
-m, --milestone string Filter by milestone title or ID
|
||||
--no-assignee Only pull requests without an assignee
|
||||
--page int Result page (default 1)
|
||||
-S, --search string Filter by text in the title or body
|
||||
--sort string Order {oldest|recentupdate|recentclose|leastupdate|mostcomment|leastcomment|priority}
|
||||
-s, --state string Filter by state {open|closed|merged|all} (default "open")
|
||||
-w, --web Open the pull request list in the browser
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr](../pr/index.md): Manage pull requests
|
||||
@@ -0,0 +1,78 @@
|
||||
---
|
||||
sidebar_position: 11
|
||||
description: "Merge a pull request"
|
||||
---
|
||||
|
||||
# gt pr merge
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Merge a pull request
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Merge a pull request on Gitea.
|
||||
|
||||
Without a method, gt uses the repository's default merge style. On a terminal, leaving out
|
||||
the method or --delete-branch asks for them, preselecting the repository's defaults. With
|
||||
--delete-branch, gt also deletes the local head branch when it is checked out, switching to
|
||||
the base branch.
|
||||
|
||||
--delete-branch deletes the head branch of a pull request from a fork too, when you can push
|
||||
to that fork: your own, or any as a site administrator. A fork you cannot push to keeps it.
|
||||
```
|
||||
|
||||
```
|
||||
gt pr merge [<number> | <url> | <branch>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# Merge the pull request of the current branch with the repository's default style
|
||||
$ gt pr merge
|
||||
|
||||
# Squash #13 and delete its branch
|
||||
$ gt pr merge 13 --squash --delete-branch
|
||||
|
||||
# Merge once the checks pass, without prompts
|
||||
$ gt pr merge 13 --auto --yes
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--auto Merge once the required checks succeed
|
||||
-d, --delete-branch Delete the head branch on Gitea and locally after merging (default: the repository setting, on Gitea only)
|
||||
-e, --editor Write the merge commit message in your editor
|
||||
-h, --help help for merge
|
||||
--merge Create a merge commit
|
||||
-b, --message string Merge commit message
|
||||
-F, --message-file file Read the merge commit message from file, or - for stdin
|
||||
-s, --method string Merge method (default: the repository's default merge style) {merge|rebase|rebase-merge|squash|fast-forward-only}
|
||||
--rebase Rebase the commits onto the base branch
|
||||
--squash Squash the commits into one commit and merge it
|
||||
-t, --title string Merge commit title
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr](../pr/index.md): Manage pull requests
|
||||
@@ -0,0 +1,59 @@
|
||||
---
|
||||
sidebar_position: 12
|
||||
description: "Mark a pull request as ready for review"
|
||||
---
|
||||
|
||||
# gt pr ready
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Mark a pull request as ready for review
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Mark a draft pull request as ready for review, or with --undo turn it back into a draft.
|
||||
|
||||
Gitea treats a pull request as a draft while its title starts with "WIP:" or "[WIP]"; gt
|
||||
removes or adds that marker.
|
||||
```
|
||||
|
||||
```
|
||||
gt pr ready [<number> | <url> | <branch>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr ready
|
||||
$ gt pr ready 15
|
||||
$ gt pr ready 15 --undo
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for ready
|
||||
--undo Turn the pull request back into a draft
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr](../pr/index.md): Manage pull requests
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
sidebar_position: 13
|
||||
description: "Reopen a pull request"
|
||||
---
|
||||
|
||||
# gt pr reopen
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Reopen a pull request
|
||||
|
||||
```
|
||||
gt pr reopen [<number> | <url> | <branch>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr reopen 13
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-c, --comment string Leave a comment before changing the state
|
||||
-h, --help help for reopen
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr](../pr/index.md): Manage pull requests
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: "Withdraw review requests"
|
||||
---
|
||||
|
||||
# gt pr review cancel-request
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Withdraw review requests
|
||||
|
||||
```
|
||||
gt pr review cancel-request [<number> | <url> | <branch>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr review cancel-request 13 --reviewer carol
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for cancel-request
|
||||
-r, --reviewer strings Reviewer usernames or email addresses; @me for yourself
|
||||
--team strings Teams of the repository's organization
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr review](../../pr/review/index.md): Review a pull request or manage its reviews
|
||||
@@ -0,0 +1,51 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: "List inline review comments"
|
||||
---
|
||||
|
||||
# gt pr review comments
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
List inline review comments
|
||||
|
||||
```
|
||||
gt pr review comments [<number> | <url> | <branch>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr review comments 13
|
||||
$ gt pr review comments 13 --review 6
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for comments
|
||||
-L, --limit int Maximum number of results (1..1000) (default 30)
|
||||
--page int Result page (default 1)
|
||||
--review ID Limit comments to one review ID
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr review](../../pr/review/index.md): Review a pull request or manage its reviews
|
||||
@@ -0,0 +1,57 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: "Submit a review (same as \"gt pr review\")"
|
||||
---
|
||||
|
||||
# gt pr review create
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Submit a review (same as "gt pr review")
|
||||
|
||||
```
|
||||
gt pr review create [<number> | <url> | <branch>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr review create 13 --approve
|
||||
$ gt pr review create --comment -b "Looks good overall"
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-a, --approve Approve the pull request
|
||||
-b, --body string Review body
|
||||
-F, --body-file file Read the body from file, or - for stdin
|
||||
-c, --comment Comment without approving (requires a body or inline comments, which can be those of the pending review it publishes; an empty --body clears that review's body when it has inline comments, and is refused otherwise)
|
||||
--comments-file file Read inline comments from a JSON file: an array of path, body, and new_position or old_position on a line of the diff
|
||||
--commit sha Commit sha to review (default: the head of the pull request)
|
||||
-e, --editor Write the body in your editor
|
||||
-h, --help help for create
|
||||
--pending Save the review as pending, to submit later with gt pr review submit
|
||||
-r, --request-changes Request changes (requires a body)
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr review](../../pr/review/index.md): Review a pull request or manage its reviews
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
description: "Delete a review"
|
||||
---
|
||||
|
||||
# gt pr review delete
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Delete a review
|
||||
|
||||
```
|
||||
gt pr review delete <number> <review-id> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr review delete 13 21
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for delete
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr review](../../pr/review/index.md): Review a pull request or manage its reviews
|
||||
@@ -0,0 +1,50 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
description: "Dismiss an approval or change request"
|
||||
---
|
||||
|
||||
# gt pr review dismiss
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Dismiss an approval or change request
|
||||
|
||||
```
|
||||
gt pr review dismiss <number> <review-id> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr review dismiss 13 6 -b "Approved an outdated revision"
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-b, --body string Reason for dismissing the review (required)
|
||||
-F, --body-file file Read the reason from file, or - for stdin
|
||||
-e, --editor Write the reason in your editor
|
||||
-h, --help help for dismiss
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr review](../../pr/review/index.md): Review a pull request or manage its reviews
|
||||
@@ -0,0 +1,90 @@
|
||||
---
|
||||
sidebar_position: 14
|
||||
description: "Review a pull request or manage its reviews"
|
||||
---
|
||||
|
||||
# gt pr review
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Review a pull request or manage its reviews
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Submit a review on a pull request, or manage existing reviews with the commands below.
|
||||
|
||||
Choose the review type with --approve, --request-changes or --comment. On a terminal, leaving
|
||||
the type out opens an interactive review that also offers to annotate the diff in your editor.
|
||||
|
||||
Gitea adds a review to your pending review on the pull request, if you have one, which publishes
|
||||
the pending review's inline comments; gt asks first, and without a terminal needs --yes. A body
|
||||
you give replaces the pending review's body, which gt warns about; without one, it is kept.
|
||||
```
|
||||
|
||||
```
|
||||
gt pr review [<number> | <url> | <branch>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# Approve the pull request of the current branch
|
||||
$ gt pr review --approve
|
||||
|
||||
# Request changes on #13
|
||||
$ gt pr review 13 -r -b "Please hash the password"
|
||||
|
||||
# Start a pending review with inline comments, then submit it
|
||||
$ gt pr review 13 --pending --comments-file inline.json
|
||||
$ gt pr review submit 13 --approve
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-a, --approve Approve the pull request
|
||||
-b, --body string Review body
|
||||
-F, --body-file file Read the body from file, or - for stdin
|
||||
-c, --comment Comment without approving (requires a body or inline comments, which can be those of the pending review it publishes; an empty --body clears that review's body when it has inline comments, and is refused otherwise)
|
||||
--comments-file file Read inline comments from a JSON file: an array of path, body, and new_position or old_position on a line of the diff
|
||||
--commit sha Commit sha to review (default: the head of the pull request)
|
||||
-e, --editor Write the body in your editor
|
||||
-h, --help help for review
|
||||
--pending Save the review as pending, to submit later with gt pr review submit
|
||||
-r, --request-changes Request changes (requires a body)
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr](../../pr/index.md): Manage pull requests
|
||||
* [gt pr review cancel-request](../../pr/review/cancel-request.md): Withdraw review requests
|
||||
* [gt pr review comments](../../pr/review/comments.md): List inline review comments
|
||||
* [gt pr review create](../../pr/review/create.md): Submit a review (same as "gt pr review")
|
||||
* [gt pr review delete](../../pr/review/delete.md): Delete a review
|
||||
* [gt pr review dismiss](../../pr/review/dismiss.md): Dismiss an approval or change request
|
||||
* [gt pr review list](../../pr/review/list.md): List reviews on a pull request
|
||||
* [gt pr review reply](../../pr/review/reply.md): Reply to an inline review comment
|
||||
* [gt pr review request](../../pr/review/request.md): Request reviews from users or teams
|
||||
* [gt pr review resolve](../../pr/review/resolve.md): Mark an inline conversation as resolved
|
||||
* [gt pr review submit](../../pr/review/submit.md): Submit your pending review
|
||||
* [gt pr review undismiss](../../pr/review/undismiss.md): Restore a dismissed review
|
||||
* [gt pr review unresolve](../../pr/review/unresolve.md): Reopen a resolved inline conversation
|
||||
* [gt pr review view](../../pr/review/view.md): View a review
|
||||
@@ -0,0 +1,50 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
description: "List reviews on a pull request"
|
||||
---
|
||||
|
||||
# gt pr review list
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
List reviews on a pull request
|
||||
|
||||
```
|
||||
gt pr review list [<number> | <url> | <branch>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr review list 13
|
||||
$ gt pr review list --json id,author,state
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for list
|
||||
-L, --limit int Maximum number of results (1..1000) (default 30)
|
||||
--page int Result page (default 1)
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr review](../../pr/review/index.md): Review a pull request or manage its reviews
|
||||
@@ -0,0 +1,50 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
description: "Reply to an inline review comment"
|
||||
---
|
||||
|
||||
# gt pr review reply
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Reply to an inline review comment
|
||||
|
||||
```
|
||||
gt pr review reply <number> <comment-id> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr review reply 13 36 -b "Done, the password is hashed now"
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-b, --body string Reply body
|
||||
-F, --body-file file Read the body from file, or - for stdin
|
||||
-e, --editor Write the reply in your editor
|
||||
-h, --help help for reply
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr review](../../pr/review/index.md): Review a pull request or manage its reviews
|
||||
@@ -0,0 +1,50 @@
|
||||
---
|
||||
sidebar_position: 8
|
||||
description: "Request reviews from users or teams"
|
||||
---
|
||||
|
||||
# gt pr review request
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Request reviews from users or teams
|
||||
|
||||
```
|
||||
gt pr review request [<number> | <url> | <branch>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr review request 13 --reviewer carol,dave
|
||||
$ gt pr review request --team developers
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for request
|
||||
-r, --reviewer strings Reviewer usernames or email addresses; @me for yourself
|
||||
--team strings Teams of the repository's organization
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr review](../../pr/review/index.md): Review a pull request or manage its reviews
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
description: "Mark an inline conversation as resolved"
|
||||
---
|
||||
|
||||
# gt pr review resolve
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Mark an inline conversation as resolved
|
||||
|
||||
```
|
||||
gt pr review resolve <comment-id> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# Find the comment IDs with: gt pr review comments 13
|
||||
$ gt pr review resolve 36
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for resolve
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr review](../../pr/review/index.md): Review a pull request or manage its reviews
|
||||
@@ -0,0 +1,58 @@
|
||||
---
|
||||
sidebar_position: 10
|
||||
description: "Submit your pending review"
|
||||
---
|
||||
|
||||
# gt pr review submit
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Submit your pending review
|
||||
|
||||
```
|
||||
gt pr review submit [<number> | <url> | <branch>] [<review-id>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# Start a pending review, then submit it as an approval
|
||||
$ gt pr review 13 --pending -b "First pass" --comments-file inline.json
|
||||
$ gt pr review submit 13 --approve
|
||||
|
||||
# Submit a pending review by its ID
|
||||
$ gt pr review submit 13 21 --request-changes -b "See the inline comments"
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-a, --approve Approve the pull request
|
||||
-b, --body string Review body (default: the body of the pending review)
|
||||
-F, --body-file file Read the body from file, or - for stdin
|
||||
-c, --comment Comment without approving (requires a body or inline comments, which can be those of the pending review it publishes; an empty --body clears that review's body when it has inline comments, and is refused otherwise)
|
||||
-e, --editor Edit the body of the pending review in your editor
|
||||
-h, --help help for submit
|
||||
-r, --request-changes Request changes (requires a body)
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr review](../../pr/review/index.md): Review a pull request or manage its reviews
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
sidebar_position: 11
|
||||
description: "Restore a dismissed review"
|
||||
---
|
||||
|
||||
# gt pr review undismiss
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Restore a dismissed review
|
||||
|
||||
```
|
||||
gt pr review undismiss <number> <review-id> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr review undismiss 13 6
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for undismiss
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr review](../../pr/review/index.md): Review a pull request or manage its reviews
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
sidebar_position: 12
|
||||
description: "Reopen a resolved inline conversation"
|
||||
---
|
||||
|
||||
# gt pr review unresolve
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Reopen a resolved inline conversation
|
||||
|
||||
```
|
||||
gt pr review unresolve <comment-id> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# Find the comment IDs with: gt pr review comments 13
|
||||
$ gt pr review unresolve 36
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for unresolve
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr review](../../pr/review/index.md): Review a pull request or manage its reviews
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
sidebar_position: 13
|
||||
description: "View a review"
|
||||
---
|
||||
|
||||
# gt pr review view
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
View a review
|
||||
|
||||
```
|
||||
gt pr review view <number> <review-id> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr review view 13 6
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for view
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr review](../../pr/review/index.md): Review a pull request or manage its reviews
|
||||
@@ -0,0 +1,56 @@
|
||||
---
|
||||
sidebar_position: 15
|
||||
description: "Show the status of your pull requests"
|
||||
---
|
||||
|
||||
# gt pr status
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Show the status of your pull requests
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Show the pull request of the current branch with its checks and review state, then the open
|
||||
pull requests you created, those assigned to you, and those that request your review.
|
||||
```
|
||||
|
||||
```
|
||||
gt pr status [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr status
|
||||
$ gt pr status -R alice/project
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for status
|
||||
--limit int Maximum results in each section (1..100) (default 30)
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr](../pr/index.md): Manage pull requests
|
||||
@@ -0,0 +1,57 @@
|
||||
---
|
||||
sidebar_position: 16
|
||||
description: "Show the activity on a pull request"
|
||||
---
|
||||
|
||||
# gt pr timeline
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Show the activity on a pull request
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Show what happened on a pull request, oldest first: comments, and changes such as labels,
|
||||
milestones, titles, assignees, references and state changes.
|
||||
```
|
||||
|
||||
```
|
||||
gt pr timeline [<number> | <url> | <branch>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt pr timeline 13
|
||||
$ gt pr timeline 13 --json type,author,created_at
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for timeline
|
||||
-L, --limit int Maximum number of results (1..1000) (default 30)
|
||||
--page int Result page (default 1)
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr](../pr/index.md): Manage pull requests
|
||||
@@ -0,0 +1,55 @@
|
||||
---
|
||||
sidebar_position: 17
|
||||
description: "View a pull request"
|
||||
---
|
||||
|
||||
# gt pr view
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
View a pull request
|
||||
|
||||
```
|
||||
gt pr view [<number> | <url> | <branch>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# View the pull request of the current branch
|
||||
$ gt pr view
|
||||
|
||||
# View #13 with its comments and reviews
|
||||
$ gt pr view 13 --comments
|
||||
|
||||
$ gt pr view feature/login --json number,state,review_decision
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-c, --comments Show comments and reviews
|
||||
-h, --help help for view
|
||||
-w, --web Open the pull request in the browser
|
||||
```
|
||||
|
||||
## Options inherited from parent commands
|
||||
|
||||
```
|
||||
--cwd directory Working directory for repository discovery
|
||||
--debug Log the method, URL, status, and duration of each HTTP request to stderr
|
||||
--host URL Gitea instance URL, including any base path
|
||||
--interactive Allow prompts with machine output
|
||||
-q, --jq expression Filter JSON output using a jq expression; implies --json
|
||||
--json fields[="*"] Output JSON with the specified comma-separated fields, or all fields
|
||||
--no-input Disable prompts and implicit editor/browser interactions
|
||||
--remote remote Git remote used for repository discovery
|
||||
-R, --repo OWNER/REPO Select a repository as OWNER/REPO or URL
|
||||
--sudo user Perform API requests as this user (requires an administrator account)
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt pr](../pr/index.md): Manage pull requests
|
||||
Reference in new issue
Block a user