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:
bircni committed 2026-10-22 11:28:15 +02:00
1 parent fe618c42be
commit 55c3a392a1
261 files changed
+15116 -2

No files matched your search

@@ -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
+51
View File
@@ -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
+57
View File
@@ -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
+47
View File
@@ -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
+50
View File
@@ -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
+90
View File
@@ -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
+50
View File
@@ -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
+50
View File
@@ -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
+50
View File
@@ -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
+48
View File
@@ -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
+58
View File
@@ -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
+47
View File
@@ -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
+48
View File
@@ -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
+47
View File
@@ -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