mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-06 01:50:30 +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,57 @@
|
||||
---
|
||||
sidebar_position: 12
|
||||
description: "Read and triage your notifications"
|
||||
---
|
||||
|
||||
# gt notification
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Read and triage your notifications
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Read and triage the notifications of your account, across your whole inbox unless -R or
|
||||
--this-repo selects a repository. IDs identify notification threads, not issue numbers. The
|
||||
type of a notification is issue, pull, commit or repository, as --type selects them.
|
||||
```
|
||||
|
||||
```
|
||||
gt notification [flags]
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for notification
|
||||
--this-repo Only notifications of the repository in the current directory
|
||||
```
|
||||
|
||||
## 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 notification list](../notification/list.md): List notifications
|
||||
* [gt notification mark-read](../notification/mark-read.md): Mark notifications as read
|
||||
* [gt notification mark-unread](../notification/mark-unread.md): Mark notifications as unread
|
||||
* [gt notification pin](../notification/pin.md): Pin notifications
|
||||
* [gt notification unpin](../notification/unpin.md): Unpin notifications
|
||||
* [gt notification view](../notification/view.md): View a notification and mark it as read
|
||||
* [gt notification watch](../notification/watch.md): Print notifications as they arrive
|
||||
@@ -0,0 +1,58 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: "List notifications"
|
||||
---
|
||||
|
||||
# gt notification list
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
List notifications
|
||||
|
||||
```
|
||||
gt notification list [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt notification list
|
||||
# Including the ones you read, of one repository
|
||||
$ gt notification list --status unread,read,pinned -R alice/project
|
||||
# Pull requests updated today
|
||||
$ gt notification list --type pull --since 24h
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--before string Only notifications updated before a date, timestamp, or duration such as 1h
|
||||
-h, --help help for list
|
||||
-L, --limit int Maximum number of results (1..1000) (default 30)
|
||||
--page int Result page (default 1)
|
||||
--since string Only notifications updated since a date, timestamp, or duration such as 24h
|
||||
--status strings Only notifications with these statuses: unread, read, pinned (default [unread,pinned])
|
||||
--type strings Only notifications about these subjects: issue, pull, commit, repository
|
||||
```
|
||||
|
||||
## 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)
|
||||
--this-repo Only notifications of the repository in the current directory
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt notification](../notification/index.md): Read and triage your notifications
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: "Mark notifications as read"
|
||||
---
|
||||
|
||||
# gt notification mark-read
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Mark notifications as read
|
||||
|
||||
```
|
||||
gt notification mark-read [<id>...] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt notification mark-read 28
|
||||
# Everything in one repository
|
||||
$ gt notification mark-read --all -R alice/project
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--all Apply to every notification that matches --status in the scope
|
||||
--before string With --all, only notifications updated before a date, timestamp, or duration such as 1h
|
||||
-h, --help help for mark-read
|
||||
--status strings With --all, the statuses to change: unread, read, pinned
|
||||
```
|
||||
|
||||
## 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)
|
||||
--this-repo Only notifications of the repository in the current directory
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt notification](../notification/index.md): Read and triage your notifications
|
||||
@@ -0,0 +1,51 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: "Mark notifications as unread"
|
||||
---
|
||||
|
||||
# gt notification mark-unread
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Mark notifications as unread
|
||||
|
||||
```
|
||||
gt notification mark-unread [<id>...] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt notification mark-unread 28 26
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--all Apply to every notification that matches --status in the scope
|
||||
--before string With --all, only notifications updated before a date, timestamp, or duration such as 1h
|
||||
-h, --help help for mark-unread
|
||||
--status strings With --all, the statuses to change: unread, read, pinned
|
||||
```
|
||||
|
||||
## 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)
|
||||
--this-repo Only notifications of the repository in the current directory
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt notification](../notification/index.md): Read and triage your notifications
|
||||
@@ -0,0 +1,51 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
description: "Pin notifications"
|
||||
---
|
||||
|
||||
# gt notification pin
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Pin notifications
|
||||
|
||||
```
|
||||
gt notification pin [<id>...] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt notification pin 28
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--all Apply to every notification that matches --status in the scope
|
||||
--before string With --all, only notifications updated before a date, timestamp, or duration such as 1h
|
||||
-h, --help help for pin
|
||||
--status strings With --all, the statuses to change: unread, read, pinned
|
||||
```
|
||||
|
||||
## 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)
|
||||
--this-repo Only notifications of the repository in the current directory
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt notification](../notification/index.md): Read and triage your notifications
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
description: "Unpin notifications"
|
||||
---
|
||||
|
||||
# gt notification unpin
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Unpin notifications
|
||||
|
||||
```
|
||||
gt notification unpin [<id>...] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt notification unpin 28
|
||||
# Unpin everything
|
||||
$ gt notification unpin --all
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--all Apply to every notification that matches --status in the scope
|
||||
--before string With --all, only notifications updated before a date, timestamp, or duration such as 1h
|
||||
-h, --help help for unpin
|
||||
--status strings With --all, the statuses to change: unread, read, pinned
|
||||
```
|
||||
|
||||
## 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)
|
||||
--this-repo Only notifications of the repository in the current directory
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt notification](../notification/index.md): Read and triage your notifications
|
||||
@@ -0,0 +1,57 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
description: "View a notification and mark it as read"
|
||||
---
|
||||
|
||||
# gt notification view
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
View a notification and mark it as read
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
View a notification: its subject, the subject's state and the latest comment. Like
|
||||
opening it on the web, viewing marks an unread notification as read; pinned ones stay
|
||||
pinned.
|
||||
```
|
||||
|
||||
```
|
||||
gt notification view <id> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt notification view 28
|
||||
$ gt notification view 28 --json title,url
|
||||
```
|
||||
|
||||
## 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)
|
||||
--this-repo Only notifications of the repository in the current directory
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt notification](../notification/index.md): Read and triage your notifications
|
||||
@@ -0,0 +1,67 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
description: "Print notifications as they arrive"
|
||||
---
|
||||
|
||||
# gt notification watch
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Print notifications as they arrive
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Print notifications as they arrive or change, until Ctrl-C or --timeout. On a terminal
|
||||
it runs until stopped; otherwise it stops after a minute unless --timeout says otherwise.
|
||||
With --json it prints one JSON object per line. It polls on through an outage of the instance
|
||||
of up to 5 minutes.
|
||||
```
|
||||
|
||||
```
|
||||
gt notification watch [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt notification watch
|
||||
# Stream pull request notifications to a script, starting with the current ones
|
||||
$ gt notification watch --type pull --json id,repository,title --timeout 0 | ./notify.sh
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--before string Only notifications updated before a date, timestamp, or duration such as 1h
|
||||
-h, --help help for watch
|
||||
--interval duration Time between checks (default 5s)
|
||||
-L, --limit int Maximum number of results (1..1000) (default 30)
|
||||
--page int Result page (default 1)
|
||||
--since string Only notifications updated since a date, timestamp, or duration such as 24h
|
||||
--status strings Only notifications with these statuses: unread, read, pinned (default [unread,pinned])
|
||||
--timeout duration Stop after this long (default: never on a terminal, 1m otherwise)
|
||||
--type strings Only notifications about these subjects: issue, pull, commit, repository
|
||||
```
|
||||
|
||||
## 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)
|
||||
--this-repo Only notifications of the repository in the current directory
|
||||
--user name Account name on the selected instance
|
||||
-y, --yes Accept confirmations without prompting
|
||||
```
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [gt notification](../notification/index.md): Read and triage your notifications
|
||||
Reference in new issue
Block a user