mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-05 17:45:46 +00:00
bircni
55c3a392a1
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]>
76 lines
2.1 KiB
Markdown
76 lines
2.1 KiB
Markdown
---
|
|
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
|