mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-06 18:10:36 +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,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
|
||||
Reference in new issue
Block a user