1
mirror of https://github.com/rclone/rclone synced 2024-12-04 14:35:20 +01:00
rclone/docs/content/commands/rclone_completion_zsh.md

55 lines
1.3 KiB
Markdown
Raw Normal View History

2021-11-01 16:42:05 +01:00
---
title: "rclone completion zsh"
2022-07-09 19:08:20 +02:00
description: "Generate the autocompletion script for zsh"
2021-11-01 16:42:05 +01:00
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
2022-07-09 19:08:20 +02:00
Generate the autocompletion script for zsh
2021-11-01 16:42:05 +01:00
## 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:
2022-07-09 19:08:20 +02:00
echo "autoload -U compinit; compinit" >> ~/.zshrc
2021-11-01 16:42:05 +01:00
2022-10-21 16:06:08 +02:00
To load completions in your current shell session:
source <(rclone completion zsh); compdef _rclone rclone
2021-11-01 16:42:05 +01:00
To load completions for every new session, execute once:
2022-07-09 19:08:20 +02:00
### Linux:
rclone completion zsh > "${fpath[1]}/_rclone"
### macOS:
2022-10-21 16:06:08 +02:00
rclone completion zsh > $(brew --prefix)/share/zsh/site-functions/_rclone
2021-11-01 16:42:05 +01:00
You will need to start a new shell for this setup to take effect.
```
rclone completion zsh [flags]
```
## Options
```
-h, --help help for zsh
--no-descriptions disable completion descriptions
```
See the [global flags page](/flags/) for global options not listed here.
## SEE ALSO
2022-07-09 19:08:20 +02:00
* [rclone completion](/commands/rclone_completion/) - Generate the autocompletion script for the specified shell
2021-11-01 16:42:05 +01:00