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

+57
View File
@@ -0,0 +1,57 @@
---
sidebar_position: 1
description: "Generate the autocompletion script for bash"
---
# gt completion bash
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Generate the autocompletion script for bash
## Synopsis
```text
Generate the completion script for bash. It needs the bash-completion package.
To load completions in every new shell, add the eval line below to ~/.bashrc (on macOS,
~/.bash_profile); bash 3.2, the default on macOS, cannot source <(gt completion bash).
```
```
gt completion bash
```
## Examples
```
$ eval "$(gt completion bash)"
```
## Options
```
-h, --help help for bash
--no-descriptions Disable completion descriptions
```
## 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 completion](../completion/index.md): Generate shell completion scripts
+64
View File
@@ -0,0 +1,64 @@
---
sidebar_position: 2
description: "Generate the autocompletion script for fish"
---
# gt completion fish
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Generate the autocompletion script for fish
## Synopsis
```text
Generate the autocompletion script for the fish shell.
To load completions in your current shell session:
gt completion fish | source
To load completions for every new session, execute once:
gt completion fish > ~/.config/fish/completions/gt.fish
You will need to start a new shell for this setup to take effect.
```
```
gt completion fish [flags]
```
## Examples
```
$ gt completion fish > ~/.config/fish/completions/gt.fish
```
## Options
```
-h, --help help for fish
--no-descriptions Disable completion descriptions
```
## 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 completion](../completion/index.md): Generate shell completion scripts
+52
View File
@@ -0,0 +1,52 @@
---
sidebar_position: 6
description: "Generate shell completion scripts"
---
# gt completion
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Generate shell completion scripts
## Synopsis
```text
Generate the autocompletion script for gt for the specified shell.
See each sub-command's help for details on how to use the generated script.
```
```
gt completion [flags]
```
## Options
```
-h, --help help for completion
```
## 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 completion bash](../completion/bash.md): Generate the autocompletion script for bash
* [gt completion fish](../completion/fish.md): Generate the autocompletion script for fish
* [gt completion powershell](../completion/powershell.md): Generate the autocompletion script for powershell
* [gt completion zsh](../completion/zsh.md): Generate the autocompletion script for zsh
@@ -0,0 +1,61 @@
---
sidebar_position: 3
description: "Generate the autocompletion script for powershell"
---
# gt completion powershell
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Generate the autocompletion script for powershell
## Synopsis
```text
Generate the autocompletion script for powershell.
To load completions in your current shell session:
gt completion powershell | Out-String | Invoke-Expression
To load completions for every new session, add the output of the above command
to your powershell profile.
```
```
gt completion powershell [flags]
```
## Examples
```
$ gt completion powershell | Out-String | Invoke-Expression
```
## Options
```
-h, --help help for powershell
--no-descriptions Disable completion descriptions
```
## 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 completion](../completion/index.md): Generate shell completion scripts
+75
View File
@@ -0,0 +1,75 @@
---
sidebar_position: 4
description: "Generate the autocompletion script for zsh"
---
# gt completion zsh
<!-- Generated by update_cli_docs.sh from the gitea/cli sources, do not edit. -->
Generate the autocompletion script for zsh
## Synopsis
```text
Generate the autocompletion script for the zsh shell.
If shell completion is not already enabled in your environment you will need
to enable it. You can execute the following once:
echo "autoload -U compinit; compinit" >> ~/.zshrc
To load completions in your current shell session:
source <(gt completion zsh)
To load completions for every new session, execute once:
#### Linux:
gt completion zsh > "${fpath[1]}/_gt"
#### macOS:
gt completion zsh > $(brew --prefix)/share/zsh/site-functions/_gt
You will need to start a new shell for this setup to take effect.
```
```
gt completion zsh [flags]
```
## Examples
```
$ source <(gt completion zsh)
```
## Options
```
-h, --help help for zsh
--no-descriptions Disable completion descriptions
```
## 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 completion](../completion/index.md): Generate shell completion scripts