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

+49
View File
@@ -0,0 +1,49 @@
---
sidebar_position: 1
description: "Close milestones"
---
# gt milestone close
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Close milestones
```
gt milestone close <milestone>... [flags]
```
## Examples
```
$ gt milestone close v1.0
$ gt milestone close v1.0 v1.1
```
## Options
```
--by-name Match numeric arguments as milestone titles rather than IDs
-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 milestone](../milestone/index.md): Manage milestones
+65
View File
@@ -0,0 +1,65 @@
---
sidebar_position: 2
description: "Create a milestone"
---
# gt milestone create
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Create a milestone
## Synopsis
```text
Create a milestone. Without flags on a terminal, a form asks for the title, description
and due date. A milestone with the same title, ignoring case, is refused unless --force updates
it, since titles address milestones.
```
```
gt milestone create [<title>] [flags]
```
## Examples
```
$ gt milestone create v1.0 --deadline 2026-12-31 --description "First release"
$ gt milestone create --title v2.0 --editor
# Update the milestone if it exists
$ gt milestone create v1.0 --deadline 2027-01-31 --force
```
## Options
```
--deadline date Due date: YYYY-MM-DD, RFC3339 or Unix timestamp; only the date counts, as the end of that day in UTC; with --force, empty clears the deadline of an existing milestone
-d, --description string Milestone description
-F, --description-file file Read the description from file, or - for stdin
-e, --editor Write the description in the configured editor
-f, --force Update the milestone if one with the same title exists
-h, --help help for create
--state string State of the new milestone {open|closed} (default "open")
-t, --title string Milestone 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 milestone](../milestone/index.md): Manage milestones
+55
View File
@@ -0,0 +1,55 @@
---
sidebar_position: 3
description: "Delete a milestone"
---
# gt milestone delete
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Delete a milestone
## Synopsis
```text
Delete a milestone. Its issues and pull requests stay, without a milestone.
```
```
gt milestone delete <milestone> [flags]
```
## Examples
```
$ gt milestone delete v0.9
$ gt milestone delete 7 --yes
```
## Options
```
--by-name Match a numeric argument as a milestone title rather than an ID
-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 milestone](../milestone/index.md): Manage milestones
+62
View File
@@ -0,0 +1,62 @@
---
sidebar_position: 4
description: "Edit a milestone"
---
# gt milestone edit
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Edit a milestone
## Synopsis
```text
Edit the title, description or due date of a milestone. Without flags on a terminal, a form
starts from the current values.
```
```
gt milestone edit <milestone> [flags]
```
## Examples
```
$ gt milestone edit v1.0 --title v1.0.0 --deadline 2027-01-31
$ gt milestone edit v1.0 --deadline=
$ gt milestone edit 3 --editor
```
## Options
```
--by-name Match a numeric argument as a milestone title rather than an ID
--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
-d, --description string Milestone description
-F, --description-file file Read the description from file, or - for stdin
-e, --editor Write the description in the configured editor
-h, --help help for edit
-t, --title string Milestone 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 milestone](../milestone/index.md): Manage milestones
+56
View File
@@ -0,0 +1,56 @@
---
sidebar_position: 11
description: "Manage milestones"
---
# gt milestone
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Manage milestones
## Synopsis
```text
Work with the milestones of a repository and the issues and pull requests in them.
Milestones are addressed by title or ID.
```
```
gt milestone [flags]
```
## Options
```
-h, --help help for milestone
```
## 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 milestone close](../milestone/close.md): Close milestones
* [gt milestone create](../milestone/create.md): Create a milestone
* [gt milestone delete](../milestone/delete.md): Delete a milestone
* [gt milestone edit](../milestone/edit.md): Edit a milestone
* [gt milestone issue](../milestone/issue/index.md): Manage the issues and pull requests of a milestone
* [gt milestone list](../milestone/list.md): List milestones
* [gt milestone reopen](../milestone/reopen.md): Reopen milestones
* [gt milestone view](../milestone/view.md): View a milestone
+49
View File
@@ -0,0 +1,49 @@
---
sidebar_position: 1
description: "Add issues or pull requests to a milestone"
---
# gt milestone issue add
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Add issues or pull requests to a milestone
```
gt milestone issue add <milestone> {<number> | <url>}... [flags]
```
## Examples
```
$ gt milestone issue add v1.0 12
$ gt milestone issue add v1.0 12 13 '#14'
```
## Options
```
--by-name Match a numeric milestone argument as a title rather than an ID
-h, --help help for add
```
## 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 milestone issue](../../milestone/issue/index.md): Manage the issues and pull requests of a milestone
@@ -0,0 +1,51 @@
---
sidebar_position: 5
description: "Manage the issues and pull requests of a milestone"
---
# gt milestone issue
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Manage the issues and pull requests of a milestone
## Synopsis
```text
List the issues and pull requests in a milestone, or add them to it and remove them from
it. Milestones are addressed by title or ID; issues and pull requests by number or URL.
```
```
gt milestone issue [flags]
```
## Options
```
-h, --help help for issue
```
## 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 milestone](../../milestone/index.md): Manage milestones
* [gt milestone issue add](../../milestone/issue/add.md): Add issues or pull requests to a milestone
* [gt milestone issue list](../../milestone/issue/list.md): List issues and pull requests in a milestone
* [gt milestone issue remove](../../milestone/issue/remove.md): Remove issues or pull requests from a milestone
@@ -0,0 +1,53 @@
---
sidebar_position: 2
description: "List issues and pull requests in a milestone"
---
# gt milestone issue list
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
List issues and pull requests in a milestone
```
gt milestone issue list <milestone> [flags]
```
## Examples
```
$ gt milestone issue list v1.0
$ gt milestone issue list v1.0 --state all --kind issues
```
## Options
```
--by-name Match a numeric argument as a milestone title rather than an ID
-h, --help help for list
--kind string List issues, pull requests or both; the kind field of each reads issue or pull {issues|pulls|all} (default "all")
-L, --limit int Maximum number of results (1..1000) (default 30)
--page int Result page (default 1)
-s, --state string Filter by state {open|closed|all} (default "open")
```
## 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 milestone issue](../../milestone/issue/index.md): Manage the issues and pull requests of a milestone
@@ -0,0 +1,49 @@
---
sidebar_position: 3
description: "Remove issues or pull requests from a milestone"
---
# gt milestone issue remove
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Remove issues or pull requests from a milestone
```
gt milestone issue remove <milestone> {<number> | <url>}... [flags]
```
## Examples
```
$ gt milestone issue remove v1.0 12
$ gt milestone issue remove v1.0 12 13 '#14'
```
## Options
```
--by-name Match a numeric milestone argument as a title rather than an ID
-h, --help help for remove
```
## 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 milestone issue](../../milestone/issue/index.md): Manage the issues and pull requests of a milestone
+57
View File
@@ -0,0 +1,57 @@
---
sidebar_position: 6
description: "List milestones"
---
# gt milestone list
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
List milestones
## Synopsis
```text
List the milestones of a repository: open ones first, then by due date.
```
```
gt milestone list [flags]
```
## Examples
```
$ gt milestone list
$ gt milestone list --state all --json title,due_on,open_issues,closed_issues
```
## Options
```
-h, --help help for list
-L, --limit int Maximum number of results (1..1000) (default 30)
--page int Result page (default 1)
-s, --state string Filter by state {open|closed|all} (default "open")
```
## 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 milestone](../milestone/index.md): Manage milestones
+49
View File
@@ -0,0 +1,49 @@
---
sidebar_position: 7
description: "Reopen milestones"
---
# gt milestone reopen
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Reopen milestones
```
gt milestone reopen <milestone>... [flags]
```
## Examples
```
$ gt milestone reopen v1.0
$ gt milestone reopen v1.0 v1.1
```
## Options
```
--by-name Match numeric arguments as milestone titles rather than IDs
-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 milestone](../milestone/index.md): Manage milestones
+50
View File
@@ -0,0 +1,50 @@
---
sidebar_position: 8
description: "View a milestone"
---
# gt milestone view
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
View a milestone
```
gt milestone view <milestone> [flags]
```
## Examples
```
$ gt milestone view v1.0
$ gt milestone view 3 --web
```
## Options
```
--by-name Match a numeric argument as a milestone title rather than an ID
-h, --help help for view
-w, --web Open the milestone 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 milestone](../milestone/index.md): Manage milestones