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,48 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: "List the artifacts of runs"
|
||||
---
|
||||
|
||||
# gt run artifact
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
List the artifacts of runs
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
List the artifacts that a run uploaded. To download them, use gt run download.
|
||||
```
|
||||
|
||||
```
|
||||
gt run artifact [flags]
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for artifact
|
||||
```
|
||||
|
||||
## 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 run](../../run/index.md): View and manage Actions workflow runs
|
||||
* [gt run artifact list](../../run/artifact/list.md): List the artifacts of a run
|
||||
@@ -0,0 +1,50 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: "List the artifacts of a run"
|
||||
---
|
||||
|
||||
# gt run artifact list
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
List the artifacts of a run
|
||||
|
||||
```
|
||||
gt run artifact list [<run-id>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# list the artifacts of a run
|
||||
$ gt run artifact list 34
|
||||
```
|
||||
|
||||
## 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 run artifact](../../run/artifact/index.md): List the artifacts of runs
|
||||
@@ -0,0 +1,57 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: "Cancel a workflow run"
|
||||
---
|
||||
|
||||
# gt run cancel
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Cancel a workflow run
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Cancel a workflow run. The run and its logs are kept; rerun it with gt run rerun.
|
||||
```
|
||||
|
||||
```
|
||||
gt run cancel [<run-id>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# cancel a run
|
||||
$ gt run cancel 34
|
||||
# cancel a run whose runner no longer responds
|
||||
$ gt run cancel 34 --force
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--force Cancel without waiting for the runner to acknowledge
|
||||
-h, --help help for cancel
|
||||
```
|
||||
|
||||
## 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 run](../run/index.md): View and manage Actions workflow runs
|
||||
@@ -0,0 +1,56 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: "Delete a workflow run"
|
||||
---
|
||||
|
||||
# gt run delete
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Delete a workflow run
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Delete a completed workflow run with its logs and artifacts. Cancel a run before deleting it.
|
||||
```
|
||||
|
||||
```
|
||||
gt run delete [<run-id>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# delete a run
|
||||
$ gt run delete 34
|
||||
# delete a run without confirmation
|
||||
$ gt run delete 34 --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 run](../run/index.md): View and manage Actions workflow runs
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
description: "Download the artifacts of a run"
|
||||
---
|
||||
|
||||
# gt run download
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Download the artifacts of a run
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Download the artifacts of a run and extract them.
|
||||
|
||||
Each artifact is extracted into a directory named after it, except a single artifact selected
|
||||
with --name, which is extracted into the destination directory itself. With --zip, the
|
||||
artifacts are saved as ZIP archives instead.
|
||||
```
|
||||
|
||||
```
|
||||
gt run download [<run-id>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# download every artifact of a run into ./<artifact name>/
|
||||
$ gt run download 34
|
||||
# extract one artifact into dist/
|
||||
$ gt run download 34 --name build --dir dist
|
||||
# save the artifacts as ZIP archives
|
||||
$ gt run download 34 --zip
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--clobber Replace an existing file
|
||||
-D, --dir string Directory to download into
|
||||
-h, --help help for download
|
||||
-n, --name strings Only download the artifacts with these names
|
||||
-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
|
||||
--zip Save each artifact as a ZIP archive instead of extracting it
|
||||
```
|
||||
|
||||
## 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 run](../run/index.md): View and manage Actions workflow runs
|
||||
@@ -0,0 +1,57 @@
|
||||
---
|
||||
sidebar_position: 18
|
||||
description: "View and manage Actions workflow runs"
|
||||
---
|
||||
|
||||
# gt run
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
View and manage Actions workflow runs
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Work with the runs of a repository's Actions workflows. Start a run with gt workflow run.
|
||||
```
|
||||
|
||||
```
|
||||
gt run [flags]
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for run
|
||||
```
|
||||
|
||||
## 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 run artifact](../run/artifact/index.md): List the artifacts of runs
|
||||
* [gt run cancel](../run/cancel.md): Cancel a workflow run
|
||||
* [gt run delete](../run/delete.md): Delete a workflow run
|
||||
* [gt run download](../run/download.md): Download the artifacts of a run
|
||||
* [gt run jobs](../run/jobs.md): List the jobs of a workflow run
|
||||
* [gt run list](../run/list.md): List workflow runs
|
||||
* [gt run logs](../run/logs.md): Print the logs of a run's jobs
|
||||
* [gt run rerun](../run/rerun.md): Rerun a workflow run
|
||||
* [gt run view](../run/view.md): View a workflow run
|
||||
* [gt run watch](../run/watch.md): Watch a run until it completes
|
||||
@@ -0,0 +1,52 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
description: "List the jobs of a workflow run"
|
||||
---
|
||||
|
||||
# gt run jobs
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
List the jobs of a workflow run
|
||||
|
||||
```
|
||||
gt run jobs [<run-id>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# list the jobs of a run
|
||||
$ gt run jobs 34
|
||||
# list the IDs of the jobs that failed
|
||||
$ gt run jobs 34 --json id,conclusion --jq '.[] | select(.conclusion == "failure") | .id'
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for jobs
|
||||
-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 run](../run/index.md): View and manage Actions workflow runs
|
||||
@@ -0,0 +1,70 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
description: "List workflow runs"
|
||||
---
|
||||
|
||||
# gt run list
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
List workflow runs
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
List the workflow runs of a repository, newest first.
|
||||
|
||||
--since and --until compare the time a run was created; gt scans up to 5000 runs to apply them.
|
||||
```
|
||||
|
||||
```
|
||||
gt run list [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# list recent runs
|
||||
$ gt run list
|
||||
# list failed runs of the CI workflow on main
|
||||
$ gt run list --workflow CI --branch main --status failure
|
||||
# list the runs created in the last day as JSON
|
||||
$ gt run list --since 24h --json id,status,conclusion,workflow
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-u, --actor string Filter by the user who triggered the run (@me for yourself)
|
||||
-b, --branch string Filter by branch
|
||||
-c, --commit string Filter by the commit that triggered the run: its full SHA, or a revision of the local clone
|
||||
-e, --event string Filter by the event that triggered the run, such as push
|
||||
-h, --help help for list
|
||||
-L, --limit int Maximum number of results (1..1000) (default 30)
|
||||
--page int Result page (default 1)
|
||||
--since string Runs created at or after a date, RFC3339 timestamp, or duration ago (24h)
|
||||
-s, --status strings Filter by status or conclusion
|
||||
--until string Runs created at or before a date, RFC3339 timestamp, or duration ago
|
||||
-w, --workflow string Filter by workflow file or 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 run](../run/index.md): View and manage Actions workflow runs
|
||||
@@ -0,0 +1,72 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
description: "Print the logs of a run's jobs"
|
||||
---
|
||||
|
||||
# gt run logs
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Print the logs of a run's jobs
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Print the logs of a run's jobs, one after another; the name of each job goes to stderr.
|
||||
|
||||
With --follow, gt waits for jobs to start and prints new log lines until they complete,
|
||||
prefixing each line with its job's name when it follows several jobs. With --output or --dir,
|
||||
it downloads the logs of the whole run as a ZIP archive instead. The URL of a job selects that job,
|
||||
like --job.
|
||||
```
|
||||
|
||||
```
|
||||
gt run logs [<run-id>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# print the logs of every job of a run
|
||||
$ gt run logs 34
|
||||
# follow the logs of one job while it runs
|
||||
$ gt run logs 34 --job build --follow
|
||||
# download the logs as a ZIP archive
|
||||
$ gt run logs 34 --output logs.zip
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--clobber Replace an existing file
|
||||
-D, --dir string Directory to download into
|
||||
--failed Only the logs of failed jobs
|
||||
-f, --follow Wait for jobs to start and print new lines until they complete
|
||||
-h, --help help for logs
|
||||
-i, --interval duration Polling interval with --follow (default 5s)
|
||||
-j, --job name or ID Only the logs of this job, by name or ID
|
||||
-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
|
||||
--timeout duration Maximum time to follow (default 1h0m0s)
|
||||
```
|
||||
|
||||
## 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 run](../run/index.md): View and manage Actions workflow runs
|
||||
@@ -0,0 +1,61 @@
|
||||
---
|
||||
sidebar_position: 8
|
||||
description: "Rerun a workflow run"
|
||||
---
|
||||
|
||||
# gt run rerun
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Rerun a workflow run
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Rerun all jobs of a completed workflow run, only its failed jobs, or a single job, which --job or
|
||||
the URL of the job selects.
|
||||
```
|
||||
|
||||
```
|
||||
gt run rerun [<run-id>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# rerun a run
|
||||
$ gt run rerun 34
|
||||
# rerun only the jobs that failed
|
||||
$ gt run rerun 34 --failed
|
||||
# rerun one job, by name or ID
|
||||
$ gt run rerun 34 --job build
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--failed Rerun only the failed jobs
|
||||
-h, --help help for rerun
|
||||
-j, --job name or ID Rerun only this job, by name or ID
|
||||
```
|
||||
|
||||
## 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 run](../run/index.md): View and manage Actions workflow runs
|
||||
@@ -0,0 +1,61 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
description: "View a workflow run"
|
||||
---
|
||||
|
||||
# gt run view
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
View a workflow run
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
View a workflow run with its jobs and their steps.
|
||||
```
|
||||
|
||||
```
|
||||
gt run view [<run-id>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# view a run with its jobs and steps
|
||||
$ gt run view 34
|
||||
# print the logs of every job of a run
|
||||
$ gt run view 34 --log
|
||||
# get the conclusion of each job as JSON
|
||||
$ gt run view 34 --json jobs --jq '.jobs[] | {name, conclusion}'
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for view
|
||||
--log Print the logs of every job instead, like gt run logs
|
||||
--no-jobs Leave out the jobs
|
||||
-w, --web Open the run 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 run](../run/index.md): View and manage Actions workflow runs
|
||||
@@ -0,0 +1,63 @@
|
||||
---
|
||||
sidebar_position: 10
|
||||
description: "Watch a run until it completes"
|
||||
---
|
||||
|
||||
# gt run watch
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Watch a run until it completes
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Watch a run until it completes, refreshing its jobs and steps on a terminal.
|
||||
|
||||
The command fails when the run completes without success. It polls on through an outage of the
|
||||
instance of up to 5 minutes.
|
||||
```
|
||||
|
||||
```
|
||||
gt run watch [<run-id>] [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# watch a run
|
||||
$ gt run watch 34
|
||||
# pick one of the runs in progress
|
||||
$ gt run watch
|
||||
# wait for a run in a script, for at most 10 minutes
|
||||
$ gt run watch 34 --timeout 10m && echo deployed
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for watch
|
||||
-i, --interval duration Refresh interval (default 3s)
|
||||
--timeout duration Maximum time to wait (default 1h0m0s)
|
||||
```
|
||||
|
||||
## 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 run](../run/index.md): View and manage Actions workflow runs
|
||||
Reference in new issue
Block a user