mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-05 17:45:46 +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 issue attachment delete
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Delete an attachment
|
||||
|
||||
```
|
||||
gt issue attachment delete {<number> | <url>} <attachment-id> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt issue attachment delete 12 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 issue attachment](../../issue/attachment/index.md): Manage the attachments of issues
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: "Download an attachment"
|
||||
---
|
||||
|
||||
# gt issue 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 issue attachment download {<number> | <url>} <attachment-id> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt issue attachment download 12 9
|
||||
$ gt issue attachment download 12 9 --output crash.log --clobber
|
||||
# Write the file to standard output
|
||||
$ gt issue attachment download 12 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 issue attachment](../../issue/attachment/index.md): Manage the attachments of issues
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: "Rename an attachment"
|
||||
---
|
||||
|
||||
# gt issue attachment edit
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Rename an attachment
|
||||
|
||||
```
|
||||
gt issue attachment edit {<number> | <url>} <attachment-id> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt issue attachment edit 12 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 issue attachment](../../issue/attachment/index.md): Manage the attachments of issues
|
||||
@@ -0,0 +1,54 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: "Manage the attachments of issues"
|
||||
---
|
||||
|
||||
# gt issue attachment
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Manage the attachments of issues
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
List, view, upload, download, rename and delete the files attached to an issue. Attachments
|
||||
are addressed by the issue number and the attachment ID that attachment list shows.
|
||||
```
|
||||
|
||||
```
|
||||
gt issue 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 issue](../../issue/index.md): Manage issues
|
||||
* [gt issue attachment delete](../../issue/attachment/delete.md): Delete an attachment
|
||||
* [gt issue attachment download](../../issue/attachment/download.md): Download an attachment
|
||||
* [gt issue attachment edit](../../issue/attachment/edit.md): Rename an attachment
|
||||
* [gt issue attachment list](../../issue/attachment/list.md): List attachments
|
||||
* [gt issue attachment upload](../../issue/attachment/upload.md): Attach a file
|
||||
* [gt issue attachment view](../../issue/attachment/view.md): View an attachment
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
description: "List attachments"
|
||||
---
|
||||
|
||||
# gt issue attachment list
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
List attachments
|
||||
|
||||
```
|
||||
gt issue attachment list {<number> | <url>} [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt issue attachment list 12
|
||||
```
|
||||
|
||||
## 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 issue attachment](../../issue/attachment/index.md): Manage the attachments of issues
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
description: "Attach a file"
|
||||
---
|
||||
|
||||
# gt issue attachment upload
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Attach a file
|
||||
|
||||
```
|
||||
gt issue attachment upload {<number> | <url>} <file> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt issue attachment upload 12 crash.log
|
||||
$ gt issue attachment upload 12 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 issue attachment](../../issue/attachment/index.md): Manage the attachments of issues
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
description: "View an attachment"
|
||||
---
|
||||
|
||||
# gt issue attachment view
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
View an attachment
|
||||
|
||||
```
|
||||
gt issue attachment view {<number> | <url>} <attachment-id> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt issue attachment view 12 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 issue attachment](../../issue/attachment/index.md): Manage the attachments of issues
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: "Close issues"
|
||||
---
|
||||
|
||||
# gt issue close
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Close issues
|
||||
|
||||
```
|
||||
gt issue close {<number> | <url>}... [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt issue close 12
|
||||
$ gt issue close 12 13 --comment "Done in #14"
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-c, --comment string Leave a comment before closing the issue
|
||||
-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 issue](../issue/index.md): Manage issues
|
||||
@@ -0,0 +1,52 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: "Add a comment to an issue"
|
||||
---
|
||||
|
||||
# gt issue comment create
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Add a comment to an issue
|
||||
|
||||
```
|
||||
gt issue comment create {<number> | <url>} [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt issue comment create 12 --body "Looks good"
|
||||
$ gt issue comment add 12 --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 issue comment](../../issue/comment/index.md): Add a comment to an issue
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: "Delete a comment"
|
||||
---
|
||||
|
||||
# gt issue comment delete
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Delete a comment
|
||||
|
||||
```
|
||||
gt issue comment delete <comment-id> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt issue 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 issue comment](../../issue/comment/index.md): Add a comment to an issue
|
||||
@@ -0,0 +1,58 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: "Edit a comment"
|
||||
---
|
||||
|
||||
# gt issue 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 issue comment edit <comment-id> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt issue comment edit 81 --body "Fixed in #15"
|
||||
$ gt issue 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 issue comment](../../issue/comment/index.md): Add a comment to an issue
|
||||
@@ -0,0 +1,69 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: "Add a comment to an issue"
|
||||
---
|
||||
|
||||
# gt issue comment
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Add a comment to an issue
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Add a comment to an issue, 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 issue comment {<number> | <url>} [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt issue comment 12 --body "Fixed in #14"
|
||||
$ gt issue comment 12 --edit-last --body "Fixed in #15"
|
||||
$ gt issue comment list 12
|
||||
```
|
||||
|
||||
## 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 issue](../../issue/index.md): Manage issues
|
||||
* [gt issue comment create](../../issue/comment/create.md): Add a comment to an issue
|
||||
* [gt issue comment delete](../../issue/comment/delete.md): Delete a comment
|
||||
* [gt issue comment edit](../../issue/comment/edit.md): Edit a comment
|
||||
* [gt issue comment list](../../issue/comment/list.md): List the comments on an issue
|
||||
* [gt issue comment view](../../issue/comment/view.md): View a comment
|
||||
@@ -0,0 +1,50 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
description: "List the comments on an issue"
|
||||
---
|
||||
|
||||
# gt issue comment list
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
List the comments on an issue
|
||||
|
||||
```
|
||||
gt issue comment list {<number> | <url>} [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt issue comment list 12
|
||||
$ gt issue comment list 12 --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 issue comment](../../issue/comment/index.md): Add a comment to an issue
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
description: "View a comment"
|
||||
---
|
||||
|
||||
# gt issue comment view
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
View a comment
|
||||
|
||||
```
|
||||
gt issue comment view <comment-id> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt issue 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 issue comment](../../issue/comment/index.md): Add a comment to an issue
|
||||
@@ -0,0 +1,82 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
description: "Create an issue"
|
||||
---
|
||||
|
||||
# gt issue create
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Create an issue
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Create an issue in a repository. Without flags on a terminal, a form asks for the title and
|
||||
body, then optionally for assignees, a milestone, labels and a due date.
|
||||
|
||||
Gitea sets labels, a milestone, assignees and a due date only for people who can write to the
|
||||
issues of the repository, and creates the issue without them for others: gt then names the
|
||||
flags or form fields it left out and fails, and warns about left-out labels of a template.
|
||||
Adding the issue to a project needs write access too; when that fails, the issue stays created
|
||||
and the error names the command that adds it later.
|
||||
|
||||
--template starts from a repository issue template: its title, body, labels and ref. --title,
|
||||
--label, --body, --body-file and --ref replace them; labels the repository lacks are left out.
|
||||
A form (YAML) template starts with an empty body. On a terminal the form opens with the title
|
||||
and body, and a template picked in the form applies its labels too. The title of a template is
|
||||
a prefix to complete, so without the form --template requires --title. --web opens the
|
||||
new-issue page with the whole template applied.
|
||||
```
|
||||
|
||||
```
|
||||
gt issue create [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt issue create
|
||||
$ gt issue create --title "Crash on start" --body "Steps to reproduce…" --label bug --milestone v1.0
|
||||
$ gt issue create --template "Bug report"
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-a, --assignee login Assign people by their login; @me for yourself
|
||||
--attachment File File to attach after creation (repeatable)
|
||||
-b, --body string Issue body
|
||||
-F, --body-file file Read 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
|
||||
-e, --editor Compose the issue body in the configured editor
|
||||
-h, --help help for create
|
||||
-l, --label name Add labels by name; prefix repo: or org: to disambiguate
|
||||
-m, --milestone title Add the issue to a milestone by title or ID
|
||||
-p, --project title Add the issue to the project with this title, the repository's or its organization's (repeatable)
|
||||
--ref string Branch or tag the issue refers to
|
||||
-T, --template name Start from the repository issue template with this name
|
||||
-t, --title string Issue title
|
||||
-w, --web Continue in the browser with the new-issue page
|
||||
```
|
||||
|
||||
## 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 issue](../issue/index.md): Manage issues
|
||||
@@ -0,0 +1,82 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
description: "Edit issues: title, body, labels, assignees, milestone, deadline"
|
||||
---
|
||||
|
||||
# gt issue edit
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Edit issues: title, body, labels, assignees, milestone, deadline
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Edit one or more issues. Without flags on a terminal, a form edits one issue at a time,
|
||||
starting from its current values. Label and assignee flags add to or remove from each issue's
|
||||
current values; the --set flags replace them. The blocked_by and blocks JSON fields cost extra
|
||||
requests, made only when the output includes them (see gt help formatting).
|
||||
|
||||
Gitea changes the milestone, assignees and due date only for people who can write to the issues
|
||||
of the repository, and leaves them as they were for the author of an issue who cannot: gt then
|
||||
names the flags or form fields it left out and fails. Gitea refuses their label changes outright,
|
||||
so gt sends the other changes first.
|
||||
```
|
||||
|
||||
```
|
||||
gt issue edit {<number> | <url>}... [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt issue edit 12 --title "Crash on start" --add-label bug
|
||||
$ gt issue edit 12 13 --add-assignee @me --milestone v1.0
|
||||
$ gt issue edit 12 --remove-label wontfix --remove-milestone
|
||||
$ gt issue edit 12 --add-blocked-by 9
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--add-assignee login Add assignees by login; @me for yourself
|
||||
--add-blocked-by issues Mark the issue as blocked by other issues: N, #N, OWNER/REPO#N or a URL
|
||||
--add-label name Add labels by name; prefix repo: or org: to disambiguate
|
||||
--add-project title Add the issue to the project with this title (repeatable)
|
||||
-b, --body string New body; empty clears it
|
||||
-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
|
||||
-e, --editor Edit the current body in the configured editor
|
||||
-h, --help help for edit
|
||||
-m, --milestone title Move the issue to a milestone by title or ID
|
||||
--ref string Branch or tag the issue refers to; empty clears it
|
||||
--remove-assignee login Remove assignees by login; @me for yourself
|
||||
--remove-blocked-by issues Lift the dependency on other issues: N, #N, OWNER/REPO#N or a URL
|
||||
--remove-label name Remove labels by name
|
||||
--remove-milestone Remove the issue from its milestone
|
||||
--remove-project title Take the issue off the project with this title (repeatable)
|
||||
--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 New 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 issue](../issue/index.md): Manage issues
|
||||
@@ -0,0 +1,58 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
description: "Manage issues"
|
||||
---
|
||||
|
||||
# gt issue
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Manage issues
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Work with the issues of a repository: list, view and create them, edit, close or reopen
|
||||
one or more, and comment on them. Gitea lists pull requests among issues, so most issue
|
||||
commands also accept a pull request number.
|
||||
```
|
||||
|
||||
```
|
||||
gt 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](../index.md): Work with Gitea from your terminal
|
||||
* [gt issue attachment](../issue/attachment/index.md): Manage the attachments of issues
|
||||
* [gt issue close](../issue/close.md): Close issues
|
||||
* [gt issue comment](../issue/comment/index.md): Add a comment to an issue
|
||||
* [gt issue create](../issue/create.md): Create an issue
|
||||
* [gt issue edit](../issue/edit.md): Edit issues: title, body, labels, assignees, milestone, deadline
|
||||
* [gt issue list](../issue/list.md): List issues in a repository
|
||||
* [gt issue reopen](../issue/reopen.md): Reopen issues
|
||||
* [gt issue timeline](../issue/timeline.md): Show the activity on an issue
|
||||
* [gt issue view](../issue/view.md): View an issue
|
||||
@@ -0,0 +1,72 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
description: "List issues in a repository"
|
||||
---
|
||||
|
||||
# gt issue list
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
List issues in a repository
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
List the issues of a repository, newest first. Filters combine: an issue must match all of them.
|
||||
Labels and milestones must exist in the repository.
|
||||
```
|
||||
|
||||
```
|
||||
gt issue list [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt issue list --label bug --state all
|
||||
$ gt issue list --assignee @me --json number,title
|
||||
$ gt issue list --no-assignee --label bug
|
||||
# Issues and pull requests in a milestone, as tab-separated values
|
||||
$ gt issue list --kind all --milestone v1.0 | cut -f1,2
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-a, --assignee string Filter by assignee; @me for yourself
|
||||
-A, --author string Filter by author; @me for yourself
|
||||
-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 "issues")
|
||||
-l, --label names Filter by label names
|
||||
-L, --limit int Maximum number of results (1..1000) (default 30)
|
||||
--mentions string Filter by mentioned user; @me for yourself
|
||||
-m, --milestone titles Filter by milestone titles or IDs, comma-separated
|
||||
--no-assignee Only issues without an assignee
|
||||
--page int Result page (default 1)
|
||||
-S, --search string Search issue titles and bodies
|
||||
--since string Updated since a date, timestamp, or duration ago
|
||||
-s, --state string Filter by state {open|closed|all} (default "open")
|
||||
--until string Updated before a date, timestamp, or duration ago
|
||||
-w, --web Open the issue 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 issue](../issue/index.md): Manage issues
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
description: "Reopen issues"
|
||||
---
|
||||
|
||||
# gt issue reopen
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Reopen issues
|
||||
|
||||
```
|
||||
gt issue reopen {<number> | <url>}... [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt issue reopen 12
|
||||
$ gt issue reopen 12 13 --comment "Still happens on v1.2"
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-c, --comment string Leave a comment before reopening the issue
|
||||
-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 issue](../issue/index.md): Manage issues
|
||||
@@ -0,0 +1,57 @@
|
||||
---
|
||||
sidebar_position: 8
|
||||
description: "Show the activity on an issue"
|
||||
---
|
||||
|
||||
# gt issue timeline
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Show the activity on an issue
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Show what happened on an issue, oldest first: comments, and changes such as labels,
|
||||
milestones, titles, assignees, references and state changes.
|
||||
```
|
||||
|
||||
```
|
||||
gt issue timeline {<number> | <url>} [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt issue timeline 12
|
||||
$ gt issue timeline 12 --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 issue](../issue/index.md): Manage issues
|
||||
@@ -0,0 +1,59 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
description: "View an issue"
|
||||
---
|
||||
|
||||
# gt issue view
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
View an issue
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Display the title, body and other information about an issue. With --comments, the
|
||||
conversation follows the body. The blocked_by and blocks JSON fields cost extra requests, made
|
||||
only when the output includes them (see gt help formatting).
|
||||
```
|
||||
|
||||
```
|
||||
gt issue view {<number> | <url>} [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt issue view 12
|
||||
$ gt issue view 12 --comments
|
||||
$ gt issue view https://gitea.com/OWNER/REPO/issues/12 --web
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-c, --comments View issue comments
|
||||
-h, --help help for view
|
||||
-w, --web Open the issue 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 issue](../issue/index.md): Manage issues
|
||||
Reference in new issue
Block a user