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,48 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: "Disable a workflow"
|
||||
---
|
||||
|
||||
# gt workflow disable
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Disable a workflow
|
||||
|
||||
```
|
||||
gt workflow disable <workflow> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# disable a workflow by name
|
||||
$ gt workflow disable Nightly
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for disable
|
||||
```
|
||||
|
||||
## 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 workflow](../workflow/index.md): View, run, enable and disable Actions workflows
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: "Enable a workflow"
|
||||
---
|
||||
|
||||
# gt workflow enable
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Enable a workflow
|
||||
|
||||
```
|
||||
gt workflow enable <workflow> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# enable a workflow by name
|
||||
$ gt workflow enable Nightly
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for enable
|
||||
```
|
||||
|
||||
## 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 workflow](../workflow/index.md): View, run, enable and disable Actions workflows
|
||||
@@ -0,0 +1,52 @@
|
||||
---
|
||||
sidebar_position: 29
|
||||
description: "View, run, enable and disable Actions workflows"
|
||||
---
|
||||
|
||||
# gt workflow
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
View, run, enable and disable Actions workflows
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Work with the Actions workflows of a repository. Inspect their runs with gt run.
|
||||
```
|
||||
|
||||
```
|
||||
gt workflow [flags]
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for workflow
|
||||
```
|
||||
|
||||
## 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 workflow disable](../workflow/disable.md): Disable a workflow
|
||||
* [gt workflow enable](../workflow/enable.md): Enable a workflow
|
||||
* [gt workflow list](../workflow/list.md): List the workflows of a repository
|
||||
* [gt workflow run](../workflow/run.md): Dispatch a workflow
|
||||
* [gt workflow view](../workflow/view.md): View a workflow and its recent runs
|
||||
@@ -0,0 +1,50 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: "List the workflows of a repository"
|
||||
---
|
||||
|
||||
# gt workflow list
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
List the workflows of a repository
|
||||
|
||||
```
|
||||
gt workflow list [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# list the workflows of the repository
|
||||
$ gt workflow list
|
||||
# list the files of disabled workflows
|
||||
$ gt workflow list --json id,state --jq '.[] | select(.state != "active") | .id'
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for list
|
||||
```
|
||||
|
||||
## 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 workflow](../workflow/index.md): View, run, enable and disable Actions workflows
|
||||
@@ -0,0 +1,76 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
description: "Dispatch a workflow"
|
||||
---
|
||||
|
||||
# gt workflow run
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Dispatch a workflow
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Start a run of a workflow that has a workflow_dispatch trigger.
|
||||
|
||||
Inputs are checked against the inputs that the workflow declares: unknown inputs, missing
|
||||
required inputs and values that a choice or boolean input does not accept are refused. In a
|
||||
terminal, gt asks for missing required inputs, or for every input when none is given.
|
||||
|
||||
The workflow is looked up among those the server lists from the default branch, so it must exist
|
||||
there; --ref only selects the branch or tag whose version of it runs, as in gh. List them with
|
||||
gt workflow list.
|
||||
|
||||
Without --ref, the workflow runs on the checked-out branch, which must be on the server, or on
|
||||
the default branch when the repository does not come from the working directory.
|
||||
|
||||
With --follow, the command fails like gt run watch when the run completes without success.
|
||||
```
|
||||
|
||||
```
|
||||
gt workflow run <workflow> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# run a workflow on the default or current branch
|
||||
$ gt workflow run CI
|
||||
# run it on a branch with inputs
|
||||
$ gt workflow run ci.yml --ref main -f target=production -f dry_run=false
|
||||
# run it and follow the logs of its jobs
|
||||
$ gt workflow run nightly --follow
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-f, --field key=value Workflow input as key=value (repeatable)
|
||||
--follow Follow the logs of the run's jobs after dispatching it
|
||||
-h, --help help for run
|
||||
--interval duration Polling interval with --follow (default 2s)
|
||||
-r, --ref string Branch or tag to run the workflow on (default: the current or default branch)
|
||||
--timeout duration Maximum time to follow (default 30m0s)
|
||||
```
|
||||
|
||||
## 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 workflow](../workflow/index.md): View, run, enable and disable Actions workflows
|
||||
@@ -0,0 +1,55 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
description: "View a workflow and its recent runs"
|
||||
---
|
||||
|
||||
# gt workflow view
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
View a workflow and its recent runs
|
||||
|
||||
```
|
||||
gt workflow view <workflow> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
# view a workflow and its recent runs
|
||||
$ gt workflow view CI
|
||||
# print the workflow file of a branch
|
||||
$ gt workflow view ci.yml --yaml --ref feature/login
|
||||
# open the workflow file in the browser
|
||||
$ gt workflow view ci --web
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for view
|
||||
-r, --ref string Branch, tag or commit of the workflow file that --yaml prints (default: the default branch)
|
||||
-w, --web Open the workflow file in the browser
|
||||
--yaml Print the workflow file
|
||||
```
|
||||
|
||||
## 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 workflow](../workflow/index.md): View, run, enable and disable Actions workflows
|
||||
Reference in new issue
Block a user