mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-06 10:00:32 +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,64 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: "Create a label"
|
||||
---
|
||||
|
||||
# gt label create
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Create a label
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Create a label. Without --color, the label gets a random color. A label with the same
|
||||
name, ignoring case, is refused unless --force updates it. Without a name on a terminal,
|
||||
prompts ask for the name, color and description.
|
||||
```
|
||||
|
||||
```
|
||||
gt label create <name> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt label create bug --color d73a4a --description "Something is broken"
|
||||
$ gt label create "priority/high" --exclusive
|
||||
# Update the label if it exists
|
||||
$ gt label create bug -c ee0701 --force
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--archived Archive the label so that it cannot be applied anymore
|
||||
-c, --color digits Color as six hexadecimal digits, such as d73a4a
|
||||
-d, --description string Description of the label
|
||||
--exclusive Allow only one label of its scope, such as priority/high, per issue
|
||||
-f, --force Update the label if one with the same name exists
|
||||
-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
|
||||
--org organization Manage the labels of an organization instead of a repository
|
||||
--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 label](../label/index.md): Manage labels
|
||||
@@ -0,0 +1,50 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
description: "Delete labels"
|
||||
---
|
||||
|
||||
# gt label delete
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Delete labels
|
||||
|
||||
```
|
||||
gt label delete <label>... [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt label delete bug
|
||||
$ gt label delete wontfix duplicate --yes
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--by-name Match numeric arguments as label names rather than IDs
|
||||
-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
|
||||
--org organization Manage the labels of an organization instead of a repository
|
||||
--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 label](../label/index.md): Manage labels
|
||||
@@ -0,0 +1,56 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
description: "Edit a label"
|
||||
---
|
||||
|
||||
# gt label edit
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Edit a label
|
||||
|
||||
```
|
||||
gt label edit <label> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt label edit bug --name defect --color b60205
|
||||
$ gt label edit "kind/question" --description "Further information is requested"
|
||||
$ gt label edit old-stuff --archived
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
--archived Archive the label so that it cannot be applied anymore
|
||||
--by-name Match a numeric argument as a label name rather than an ID
|
||||
-c, --color digits Color as six hexadecimal digits, such as d73a4a
|
||||
-d, --description string Description of the label
|
||||
--exclusive Allow only one label of its scope, such as priority/high, per issue
|
||||
-h, --help help for edit
|
||||
-n, --name string Rename the label
|
||||
```
|
||||
|
||||
## 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
|
||||
--org organization Manage the labels of an organization instead of a repository
|
||||
--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 label](../label/index.md): Manage labels
|
||||
@@ -0,0 +1,59 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
description: "Export labels to a label file"
|
||||
---
|
||||
|
||||
# gt label export
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Export labels to a label file
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Write every label as a row of a label file, the format gt label import reads, to standard
|
||||
output or to a new file.
|
||||
```
|
||||
|
||||
```
|
||||
gt label export [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt label export > labels.txt
|
||||
$ gt label export --org acme --output labels.txt
|
||||
# Copy the labels of one repository to another
|
||||
$ gt label export -R alice/old | gt label import - -R alice/new
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for export
|
||||
-O, --output file Write to a new file instead of standard output
|
||||
```
|
||||
|
||||
## 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
|
||||
--org organization Manage the labels of an organization instead of a repository
|
||||
--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 label](../label/index.md): Manage labels
|
||||
@@ -0,0 +1,61 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
description: "Create labels from a file"
|
||||
---
|
||||
|
||||
# gt label import
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Create labels from a file
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Create the labels of a label file, one per line: "#color name", optionally followed by
|
||||
" ;description" and then by the flags in one last field: " ;exclusive", " ;archived" or
|
||||
" ;exclusive,archived". The description can be left out before the flags, as in
|
||||
"#7057ff priority/high ;exclusive". gt label export writes this format, and Gitea's label
|
||||
templates use it. Blank lines and lines starting with "# " or "##" are comments; any other
|
||||
line must be a valid label. Existing labels are refused unless --force updates them.
|
||||
```
|
||||
|
||||
```
|
||||
gt label import <file> [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt label import labels.txt
|
||||
$ gt label export --repo alice/old | gt label import - --repo alice/new
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-f, --force Update labels that exist already
|
||||
-h, --help help for import
|
||||
```
|
||||
|
||||
## 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
|
||||
--org organization Manage the labels of an organization instead of a repository
|
||||
--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 label](../label/index.md): Manage labels
|
||||
@@ -0,0 +1,55 @@
|
||||
---
|
||||
sidebar_position: 10
|
||||
description: "Manage labels"
|
||||
---
|
||||
|
||||
# gt label
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
Manage labels
|
||||
|
||||
## Synopsis
|
||||
|
||||
```text
|
||||
Work with the labels of a repository or, with --org, of an organization. Labels are
|
||||
addressed by name or ID.
|
||||
```
|
||||
|
||||
```
|
||||
gt label [flags]
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for label
|
||||
--org organization Manage the labels of an organization instead of a 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)
|
||||
--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 label create](../label/create.md): Create a label
|
||||
* [gt label delete](../label/delete.md): Delete labels
|
||||
* [gt label edit](../label/edit.md): Edit a label
|
||||
* [gt label export](../label/export.md): Export labels to a label file
|
||||
* [gt label import](../label/import.md): Create labels from a file
|
||||
* [gt label list](../label/list.md): List labels
|
||||
@@ -0,0 +1,52 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
description: "List labels"
|
||||
---
|
||||
|
||||
# gt label list
|
||||
|
||||
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
|
||||
|
||||
List labels
|
||||
|
||||
```
|
||||
gt label list [flags]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
$ gt label list
|
||||
$ gt label list --org acme
|
||||
$ gt label list --json name,color
|
||||
```
|
||||
|
||||
## 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
|
||||
--org organization Manage the labels of an organization instead of a repository
|
||||
--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 label](../label/index.md): Manage labels
|
||||
Reference in new issue
Block a user