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,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
|
||||
Reference in new issue
Block a user