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