mirror of
https://github.com/rclone/rclone.git
synced 2026-01-03 17:13:18 +00:00
Version v1.63.0
This commit is contained in:
@@ -1,54 +1,48 @@
|
||||
---
|
||||
title: "rclone completion zsh"
|
||||
description: "Generate the autocompletion script for zsh"
|
||||
description: "Output zsh completion script for rclone."
|
||||
slug: rclone_completion_zsh
|
||||
url: /commands/rclone_completion_zsh/
|
||||
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/completion/zsh/ and as part of making a release run "make commanddocs"
|
||||
---
|
||||
# rclone completion zsh
|
||||
|
||||
Generate the autocompletion script for zsh
|
||||
Output zsh completion script for rclone.
|
||||
|
||||
## Synopsis
|
||||
|
||||
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:
|
||||
Generates a zsh autocompletion script for rclone.
|
||||
|
||||
echo "autoload -U compinit; compinit" >> ~/.zshrc
|
||||
This writes to /usr/share/zsh/vendor-completions/_rclone by default so will
|
||||
probably need to be run with sudo or as root, e.g.
|
||||
|
||||
To load completions in your current shell session:
|
||||
sudo rclone genautocomplete zsh
|
||||
|
||||
source <(rclone completion zsh); compdef _rclone rclone
|
||||
Logout and login again to use the autocompletion scripts, or source
|
||||
them directly
|
||||
|
||||
To load completions for every new session, execute once:
|
||||
autoload -U compinit && compinit
|
||||
|
||||
### Linux:
|
||||
If you supply a command line argument the script will be written
|
||||
there.
|
||||
|
||||
rclone completion zsh > "${fpath[1]}/_rclone"
|
||||
|
||||
### macOS:
|
||||
|
||||
rclone completion zsh > $(brew --prefix)/share/zsh/site-functions/_rclone
|
||||
|
||||
You will need to start a new shell for this setup to take effect.
|
||||
If output_file is "-", then the output will be written to stdout.
|
||||
|
||||
|
||||
```
|
||||
rclone completion zsh [flags]
|
||||
rclone completion zsh [output_file] [flags]
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
```
|
||||
-h, --help help for zsh
|
||||
--no-descriptions disable completion descriptions
|
||||
-h, --help help for zsh
|
||||
```
|
||||
|
||||
See the [global flags page](/flags/) for global options not listed here.
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* [rclone completion](/commands/rclone_completion/) - Generate the autocompletion script for the specified shell
|
||||
* [rclone completion](/commands/rclone_completion/) - Output completion script for a given shell.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user