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:
bircni committed 2026-10-22 11:28:15 +02:00
1 parent fe618c42be
commit 55c3a392a1
261 files changed
+15116 -2

No files matched your search

+52
View File
@@ -0,0 +1,52 @@
---
sidebar_position: 1
description: "Delete a variable"
---
# gt variable delete
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Delete a variable
```
gt variable delete <name> [flags]
```
## Examples
```
# delete a repository variable
$ gt variable delete DEPLOY_TOKEN
# delete an organization variable without confirmation
$ gt variable delete DEPLOY_TOKEN --org acme --yes
```
## Options
```
--account Use the variables of your user account instead of a repository or organization
-h, --help help for delete
-o, --org string Use the variables 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 variable](../variable/index.md): Manage Actions variables for a repository, organization, or your account
+50
View File
@@ -0,0 +1,50 @@
---
sidebar_position: 2
description: "Print the value of a variable"
---
# gt variable get
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Print the value of a variable
```
gt variable get <name> [flags]
```
## Examples
```
# use the value of a variable in a script
$ region=$(gt variable get REGION --org acme)
```
## Options
```
--account Use the variables of your user account instead of a repository or organization
-h, --help help for get
-o, --org string Use the variables 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 variable](../variable/index.md): Manage Actions variables for a repository, organization, or your account
+58
View File
@@ -0,0 +1,58 @@
---
sidebar_position: 25
description: "Manage Actions variables for a repository, organization, or your account"
---
# gt variable
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Manage Actions variables for a repository, organization, or your account
## Synopsis
```text
Manage the Actions variables that workflows read with ${{ vars.NAME }}.
A variable belongs to a repository, to an organization (--org), whose repositories all see it, or
to your user account (--account), which all your repositories see. Without --org or --account,
gt uses the repository of the working directory or --repo. Names are stored upper-cased.
Note that the global --user flag selects the account gt acts as, not a scope.
```
```
gt variable [flags]
```
## Options
```
-h, --help help for variable
```
## 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 variable delete](../variable/delete.md): Delete a variable
* [gt variable get](../variable/get.md): Print the value of a variable
* [gt variable list](../variable/list.md): List variables
* [gt variable set](../variable/set.md): Create or update a variable
* [gt variable view](../variable/view.md): View a variable
+54
View File
@@ -0,0 +1,54 @@
---
sidebar_position: 3
description: "List variables"
---
# gt variable list
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
List variables
```
gt variable list [flags]
```
## Examples
```
# list the variables of the repository
$ gt variable list
# list the variables of an organization
$ gt variable list --org acme
```
## Options
```
--account Use the variables of your user account instead of a repository or organization
-h, --help help for list
-L, --limit int Maximum number of results (1..1000) (default 30)
-o, --org string Use the variables of an organization instead of a repository
--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 variable](../variable/index.md): Manage Actions variables for a repository, organization, or your account
+68
View File
@@ -0,0 +1,68 @@
---
sidebar_position: 4
description: "Create or update a variable"
---
# gt variable set
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Create or update a variable
## Synopsis
```text
Create or update a variable.
The value comes from --body, --body-file or standard input when it is not a terminal (one
trailing line break is removed), or else from a prompt. --env-file sets every NAME=value of a
dotenv file instead.
```
```
gt variable set [<name>] [flags]
```
## Examples
```
# set a repository variable
$ gt variable set ENVIRONMENT --body staging
# set an organization variable from a file
$ gt variable set CONFIG --org acme < config.json
# set the variables of a dotenv file
$ gt variable set --env-file .env
```
## Options
```
--account Use the variables of your user account instead of a repository or organization
-b, --body string The value
-F, --body-file string Read the value from a file, or - for standard input
-d, --description string Description
-f, --env-file string Set every NAME=value of a dotenv file, or - for standard input
-h, --help help for set
-o, --org string Use the variables 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 variable](../variable/index.md): Manage Actions variables for a repository, organization, or your account
+50
View File
@@ -0,0 +1,50 @@
---
sidebar_position: 5
description: "View a variable"
---
# gt variable view
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
View a variable
```
gt variable view <name> [flags]
```
## Examples
```
# view a variable with its description
$ gt variable view ENVIRONMENT
```
## Options
```
--account Use the variables of your user account instead of a repository or organization
-h, --help help for view
-o, --org string Use the variables 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 variable](../variable/index.md): Manage Actions variables for a repository, organization, or your account