nprasad2077/docs

1 Fork 0

mirror of https://gitea.com/gitea/docs.git synced 2026-11-05 17:45:46 +00:00

Files

T

bircni 55c3a392a1 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]>

2026-10-22 11:28:15 +02:00

2.7 KiB

Raw Blame History

sidebar_position, description

sidebar_position	description
7	Print notifications as they arrive

gt notification watch

Print notifications as they arrive

Synopsis

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

2.7 KiB Raw Blame History